channels
caution
All props/parameters are optional unless they are marked with an asterisk ( * ).
Functions
| Name | Parameters | Return Type | Description |
|---|---|---|---|
getAllThreadsForParent | * channelId: string | Channel[] | Gets all fetched threads by its channel (parent) id |
getBasicChannel | * channelId: string | Channel | undefined | Gets the basic channel by its id |
getChannel | * channelId: string | Channel | undefined | Gets the channel by its id |
getChannelId | guildId: string fallbackToDefault: boolean | string | undefined | Gets the current selected channel id |
getChannelIds | guildId: string | string[] | Gets all channel ids |
getCurrentlySelectedChannelId | guildId: string | string | undefined | Gets the current selected channel id |
getDMFromUserId | * userId: string | string | undefined | Gets the DM channel id by its user id |
getDMUserIds | string[] | Gets all DM channel ids | |
getGuildChannelsVersion | * guildId: string | number | Gets the channel version by guild id |
getInitialOverlayState | Record<string, Channel> | Gets all guild and DM channels | |
getLastChannelFollowingDestination | LastChannelFollowingDestination | Gets information on the last channel follow | |
getLastSelectedChannelId | guildId: string | string | undefined | Gets the last selected channel id |
getLastSelectedChannels | * guildId: string | string | undefined | Gets the last selected channel id by its guild id |
getMostRecentSelectedTextChannelId | guildId: string | string | null | Gets the last selected text channel id by its guild id |
getMutableBasicGuildChannelsForGuild | * guildId: string | Record<string, Channel> | Gets all basic channels by its guild id |
getMutableGuildChannelsForGuild | * guildId: string | Record<string, Channel> | Gets all channels by its guild id |
getMutablePrivateChannels | Record<string, Channel> | Gets all DM channels | |
getPrivateChannelsVersion | number | Gets the DM channel version | |
getSortedPrivateChannels | Channel[] | Gets all DM channels sorted by the last message | |
getVoiceChannelId | string | null | Gets the current voice channel id | |
hasChannel | * channelId: string | boolean | Checks if the channel id is registered in the channel store |
loadAllGuildAndPrivateChannelsFromDisk | Record<string, Channel> | Gets all guild and DM channels |
Types
LastChannelFollowingDestination
| Name | Type | Description |
|---|---|---|
channelId | string | Channel id of the last followed channel |
guildId | string | Guild id of the last followed channel |