guilds
caution
All props/parameters are optional unless they are marked with an asterisk ( * ).
Functions
Name | Parameters | Return Type | Description |
---|---|---|---|
getCurrentGuild | Guild | undefined | Gets the currently selected guild object | |
getGuild | * guildId : string | Guild | undefined | Gets the guild by its id |
getGuildCount | number | Gets the number of how many guilds the current user is in | |
getGuildId | string | null | Gets the id of the currently selected guild | |
getGuildIds | string[] | Gets all guild ids | |
getGuilds | Record<string, Guild> | Gets all guilds | |
getLastSelectedGuildId | string | null | Gets the last selected guild id | |
getLastSelectedTimestamp | * guildId : string | number | Gets the timestamp of when a specific guild was last selected |
getState | State | Gets an object containing some information about guild selections | |
isLoaded | boolean | Gets a value indicating whether all initial guilds have been loaded |
Types
State
Name | Type | Description |
---|---|---|
lastSelectedGuildId | string | Last selected guild id |
selectedGuildId | string | Current selected guild id |
selectedGuildTimestampMillis | Record<string, number> | Object containing timestamps of when guilds were selected |