valkyrie-docs/docs/api/valkyrie-js.entities.notification.md

83 lines
1.5 KiB
Markdown
Raw Normal View History

2023-08-01 05:58:34 -07:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Notification](./valkyrie-js.entities.notification)
## entities.Notification type
**Signature:**
```typescript
export declare 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](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [User](./valkyrie-js.entities.user)<!-- -->, [Note](./valkyrie-js.entities.note)<!-- -->, [UserGroup](./valkyrie-js.entities.usergroup)