jormungandr-bite/packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.notification.md
Laura Hausmann 91dddc439f
[sdk] Rename iceshrimp-js package to iceshrimp-sdk
This resolves possible confusion between iceshrimp-js (this project) and iceshrimp-sdk (the package)
2024-07-23 23:15:19 +02:00

1.7 KiB

Home > iceshrimp-sdk > entities > Notification

entities.Notification type

Signature:

export type Notification = {
    id: ID;
    createdAt: DateString;
    isRead: boolean;
} & ({
    type: "reaction";
    reaction: string;
    user: User;
    userId: User["id"];
    note: Note;
} | {
    type: "reply";
    user: User;
    userId: User["id"];
    note: Note;
} | {
    type: "renote";
    user: User;
    userId: User["id"];
    note: Note;
} | {
    type: "quote";
    user: User;
    userId: User["id"];
    note: Note;
} | {
    type: "mention";
    user: User;
    userId: User["id"];
    note: Note;
} | {
    type: "pollVote";
    user: User;
    userId: User["id"];
    note: Note;
} | {
    type: "follow";
    user: User;
    userId: User["id"];
} | {
    type: "followRequestAccepted";
    user: User;
    userId: User["id"];
} | {
    type: "receiveFollowRequest";
    user: User;
    userId: User["id"];
} | {
    type: "groupInvited";
    invitation: UserGroup;
    user: User;
    userId: User["id"];
} | {
    type: "app";
    header?: string | null;
    body: string;
    icon?: string | null;
});

References: ID, DateString, User, Note, UserGroup