Class REST/Lobbies

Various methods for interacting with lobbies. Located at Client#rest .lobbies.

Index

Constructors

Methods

addMember bulkUpdateMembers create createCurrentUserInvite createInvite createMessage delete edit get getMessages joinOrCreate leave linkChannel removeMember unlinkChannel updateMessageModerationMetadata

Constructors

constructor

new Lobbies(manager): REST/Lobbies
Parameters
- manager: RESTManager
Returns REST/Lobbies
- Defined in lib/routes/Lobbies.ts:23

Methods

addMember

addMember(lobbyID, userID, options?): Promise<LobbyMember>
Add a member to a lobby.
Parameters
- lobbyID: string
  The ID of the lobby to add the member to.
- userID: string
  The ID of the user to add to the lobby.
- Optional options: AddLobbyMemberOptions
  The options for adding the member to the lobby.
Returns Promise<LobbyMember>
- Defined in lib/routes/Lobbies.ts:40

bulkUpdateMembers

bulkUpdateMembers(lobbyID, members): Promise<LobbyMember[]>
Bulk update members in a lobby.
Parameters
- lobbyID: string
  The ID of the lobby to update members in.
- members: BulkUpdateLobbyMemberOptions[]
  The members to update.
Returns Promise<LobbyMember[]>
- Defined in lib/routes/Lobbies.ts:58

create

create(options?): Promise<Lobby>
Create a new lobby.
Parameters
- Optional options: CreateLobbyOptions
  The options for creating the lobby.
Returns Promise<Lobby>
Caching
This method does not cache its result.
- Defined in lib/routes/Lobbies.ts:75

createCurrentUserInvite

createCurrentUserInvite(lobbyID, accessToken?): Promise<LobbyInvite>
Create an invite for the current user to join a lobby's linked channel. This requires bearer token authentication.
Parameters
- lobbyID: string
  The ID of the lobby to create the invite for.
- Optional accessToken: string
  An optional access token to use instead of the client's token. This overrides the client's auth.
Returns Promise<LobbyInvite>
- Defined in lib/routes/Lobbies.ts:94

createInvite

createInvite(lobbyID, userID, accessToken?): Promise<LobbyInvite>
Create an invite for a user to join a lobby's linked channel. This requires bearer token authentication.
Parameters
- lobbyID: string
  The ID of the lobby to create the invite for.
- userID: string
  The ID of the user to create the invite for.
- Optional accessToken: string
  An optional access token to use instead of the client's token. This overrides the client's auth.
Returns Promise<LobbyInvite>
- Defined in lib/routes/Lobbies.ts:108

createMessage

createMessage(lobbyID, options, accessToken?): Promise<LobbyMessage>
Create a message in a lobby. This requires bearer token authentication.
Parameters
- lobbyID: string
  The ID of the lobby to create the message in.
- options: CreateLobbyMessageOptions
  The options for creating the message.
- Optional accessToken: string
  An optional access token to use instead of the client's token. This overrides the client's auth.
Returns Promise<LobbyMessage>
- Defined in lib/routes/Lobbies.ts:122

delete

delete(lobbyID): Promise<void>
Delete a lobby.
Parameters
- lobbyID: string
  The ID of the lobby to delete.
Returns Promise<void>
- Defined in lib/routes/Lobbies.ts:140

edit

edit(lobbyID, options): Promise<Lobby>
Edit a lobby.
Parameters
- lobbyID: string
  The ID of the lobby to edit.
- options: EditLobbyOptions
  The options for editing the lobby.
Returns Promise<Lobby>
- Defined in lib/routes/Lobbies.ts:152

get

get(lobbyID): Promise<Lobby>
Get a lobby.
Parameters
- lobbyID: string
  The ID of the lobby to retrieve.
Returns Promise<Lobby>
- Defined in lib/routes/Lobbies.ts:170

getMessages

getMessages(lobbyID, options?, accessToken?): Promise<LobbyMessage[]>
Get messages in a lobby. This requires bearer token authentication.
Parameters
- lobbyID: string
  The ID of the lobby to get messages from.
- Optional options: GetLobbyMessagesOptions
  The options for getting the messages.
- Optional accessToken: string
  An optional access token to use instead of the client's token. This overrides the client's auth.
Returns Promise<LobbyMessage[]>
- Defined in lib/routes/Lobbies.ts:183

joinOrCreate

joinOrCreate(options): Promise<Lobby>
Join an existing lobby or create a new lobby.
Parameters
- options: JoinLobbyOptions
  The options for joining or creating the lobby.
Returns Promise<Lobby>
Caching
This method does not cache its result.
- Defined in lib/routes/Lobbies.ts:200

leave

leave(lobbyID, accessToken?): Promise<void>
Leave a lobby. This requires bearer token authentication.
Parameters
- lobbyID: string
  The ID of the lobby to leave.
- Optional accessToken: string
  An optional access token to use instead of the client's token. This overrides the client's auth.
Returns Promise<void>
- Defined in lib/routes/Lobbies.ts:228

linkChannel

linkChannel(lobbyID, channelID, accessToken?): Promise<Lobby>
Link a lobby to a channel. This requires bearer token authentication and the CAN_LINK_LOBBY flag on the member.
Parameters
- lobbyID: string
  The ID of the lobby to link the channel to.
- channelID: undefined | string
  The ID of the channel to link the lobby to.
- Optional accessToken: string
  An optional access token to use instead of the client's token. This overrides the client's auth.
Returns Promise<Lobby>
- Defined in lib/routes/Lobbies.ts:242

removeMember

removeMember(lobbyID, userID): Promise<void>
Remove a member from a lobby.
Parameters
- lobbyID: string
  The ID of the lobby to remove the member from.
- userID: string
  The ID of the user to remove from the lobby.
Returns Promise<void>
- Defined in lib/routes/Lobbies.ts:256

unlinkChannel

unlinkChannel(lobbyID, accessToken?): Promise<Lobby>
Unlink a lobby from a channel. This requires bearer token authentication and the CAN_LINK_LOBBY flag on the member.
Parameters
- lobbyID: string
  The ID of the lobby to unlink the channel from.
- Optional accessToken: string
  An optional access token to use instead of the client's token. This overrides the client's auth.
Returns Promise<Lobby>
- Defined in lib/routes/Lobbies.ts:268

updateMessageModerationMetadata

updateMessageModerationMetadata(lobbyID, messageID, metadata): Promise<void>
Update the moderation metadata for a message in a lobby.
Parameters
- lobbyID: string
  The ID of the lobby the message is in.
- messageID: string
  The ID of the message to update the metadata for.
- metadata: Record<string, string>
  The metadata to set for the message.
Returns Promise<void>
- Defined in lib/routes/Lobbies.ts:278

Class REST/Lobbies

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns REST/Lobbies

Methods

addMember

Parameters

Returns Promise<LobbyMember>

bulkUpdateMembers

Parameters

Returns Promise<LobbyMember[]>

create

Parameters

Returns Promise<Lobby>

Caching

createCurrentUserInvite

Parameters

Returns Promise<LobbyInvite>

createInvite

Parameters

Returns Promise<LobbyInvite>

createMessage

Parameters

Returns Promise<LobbyMessage>

delete

Parameters

Returns Promise<void>

edit

Parameters

Returns Promise<Lobby>

get

Parameters

Returns Promise<Lobby>

getMessages

Parameters

Returns Promise<LobbyMessage[]>

joinOrCreate

Parameters

Returns Promise<Lobby>

Caching

leave

Parameters

Returns Promise<void>

linkChannel

Parameters

Returns Promise<Lobby>

removeMember

Parameters

Returns Promise<void>

unlinkChannel

Parameters

Returns Promise<Lobby>

updateMessageModerationMetadata

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page