2023-06-24 04:13:03 +00:00
|
|
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
|
2023-07-02 22:18:30 +00:00
|
|
|
[Home](./index.md) > [firefish-js](./firefish-js.md) > [Channels](./firefish-js.channels.md)
|
2023-06-24 04:13:03 +00:00
|
|
|
|
|
|
|
## Channels type
|
|
|
|
|
|
|
|
**Signature:**
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
export declare type Channels = {
|
|
|
|
main: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
notification: (payload: Notification) => void;
|
|
|
|
mention: (payload: Note) => void;
|
|
|
|
reply: (payload: Note) => void;
|
|
|
|
renote: (payload: Note) => void;
|
|
|
|
follow: (payload: User) => void;
|
|
|
|
followed: (payload: User) => void;
|
|
|
|
unfollow: (payload: User) => void;
|
|
|
|
meUpdated: (payload: MeDetailed) => void;
|
|
|
|
pageEvent: (payload: PageEvent) => void;
|
|
|
|
urlUploadFinished: (payload: {
|
|
|
|
marker: string;
|
|
|
|
file: DriveFile;
|
|
|
|
}) => void;
|
|
|
|
readAllNotifications: () => void;
|
|
|
|
unreadNotification: (payload: Notification) => void;
|
|
|
|
unreadMention: (payload: Note["id"]) => void;
|
|
|
|
readAllUnreadMentions: () => void;
|
|
|
|
unreadSpecifiedNote: (payload: Note["id"]) => void;
|
|
|
|
readAllUnreadSpecifiedNotes: () => void;
|
|
|
|
readAllMessagingMessages: () => void;
|
|
|
|
messagingMessage: (payload: MessagingMessage) => void;
|
|
|
|
unreadMessagingMessage: (payload: MessagingMessage) => void;
|
|
|
|
readAllAntennas: () => void;
|
|
|
|
unreadAntenna: (payload: Antenna) => void;
|
|
|
|
readAllAnnouncements: () => void;
|
|
|
|
readAllChannels: () => void;
|
|
|
|
unreadChannel: (payload: Note["id"]) => void;
|
|
|
|
myTokenRegenerated: () => void;
|
|
|
|
reversiNoInvites: () => void;
|
|
|
|
reversiInvited: (payload: FIXME) => void;
|
|
|
|
signin: (payload: FIXME) => void;
|
|
|
|
registryUpdated: (payload: {
|
|
|
|
scope?: string[];
|
|
|
|
key: string;
|
|
|
|
value: any | null;
|
|
|
|
}) => void;
|
|
|
|
driveFileCreated: (payload: DriveFile) => void;
|
|
|
|
readAntenna: (payload: Antenna) => void;
|
|
|
|
};
|
|
|
|
receives: null;
|
|
|
|
};
|
|
|
|
homeTimeline: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
note: (payload: Note) => void;
|
|
|
|
};
|
|
|
|
receives: null;
|
|
|
|
};
|
|
|
|
localTimeline: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
note: (payload: Note) => void;
|
|
|
|
};
|
|
|
|
receives: null;
|
|
|
|
};
|
|
|
|
hybridTimeline: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
note: (payload: Note) => void;
|
|
|
|
};
|
|
|
|
receives: null;
|
|
|
|
};
|
|
|
|
recommendedTimeline: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
note: (payload: Note) => void;
|
|
|
|
};
|
|
|
|
receives: null;
|
|
|
|
};
|
|
|
|
globalTimeline: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
note: (payload: Note) => void;
|
|
|
|
};
|
|
|
|
receives: null;
|
|
|
|
};
|
|
|
|
antenna: {
|
|
|
|
params: {
|
|
|
|
antennaId: Antenna["id"];
|
|
|
|
};
|
|
|
|
events: {
|
|
|
|
note: (payload: Note) => void;
|
|
|
|
};
|
|
|
|
receives: null;
|
|
|
|
};
|
|
|
|
messaging: {
|
|
|
|
params: {
|
|
|
|
otherparty?: User["id"] | null;
|
|
|
|
group?: UserGroup["id"] | null;
|
|
|
|
};
|
|
|
|
events: {
|
|
|
|
message: (payload: MessagingMessage) => void;
|
|
|
|
deleted: (payload: MessagingMessage["id"]) => void;
|
|
|
|
read: (payload: MessagingMessage["id"][]) => void;
|
|
|
|
typers: (payload: User[]) => void;
|
|
|
|
};
|
|
|
|
receives: {
|
|
|
|
read: {
|
|
|
|
id: MessagingMessage["id"];
|
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
serverStats: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
stats: (payload: FIXME) => void;
|
|
|
|
};
|
|
|
|
receives: {
|
|
|
|
requestLog: {
|
|
|
|
id: string | number;
|
|
|
|
length: number;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
queueStats: {
|
|
|
|
params: null;
|
|
|
|
events: {
|
|
|
|
stats: (payload: FIXME) => void;
|
|
|
|
};
|
|
|
|
receives: {
|
|
|
|
requestLog: {
|
|
|
|
id: string | number;
|
|
|
|
length: number;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
```
|
2023-07-02 22:18:30 +00:00
|
|
|
**References:** [Note](./firefish-js.entities.note.md)<!-- -->, [User](./firefish-js.entities.user.md)<!-- -->, [MeDetailed](./firefish-js.entities.medetailed.md)<!-- -->, [PageEvent](./firefish-js.entities.pageevent.md)<!-- -->, [DriveFile](./firefish-js.entities.drivefile.md)<!-- -->, [MessagingMessage](./firefish-js.entities.messagingmessage.md)<!-- -->, [Antenna](./firefish-js.entities.antenna.md)<!-- -->, [UserGroup](./firefish-js.entities.usergroup.md)
|
2023-06-24 04:13:03 +00:00
|
|
|
|