Class Lobby

constructor

• new Lobby(data, client): Lobby

• Parameters

  • data: RawLobby
  • client: Client<ClientEvents>

  Returns Lobby

applicationID

Optional flags

Optional linkedChannel

members

Optional metadata

addMember

• addMember(userID, options?): Promise<LobbyMember>

• Add a member to this lobby.

  Parameters

  • 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>

bulkUpdateMembers

• bulkUpdateMembers(members): Promise<LobbyMember[]>

• Bulk update members in this lobby.

  Parameters

  • members: BulkUpdateLobbyMemberOptions[]

    The members to update.

  Returns Promise<LobbyMember[]>

createCurrentUserInvite

• createCurrentUserInvite(accessToken?): Promise<LobbyInvite>

• Create an invite for the current user to join this lobby's linked channel. This requires bearer token authentication.

  Parameters

  • Optional accessToken: string

    An optional access token to use instead of the client's token. This overrides the client's auth.

  Returns Promise<LobbyInvite>

createInvite

• createInvite(userID, accessToken?): Promise<LobbyInvite>

• Create an invite for a user to join this lobby's linked channel. This requires bearer token authentication.

  Parameters

  • 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>

createMessage

• createMessage(options, accessToken?): Promise<LobbyMessage>

• Create a message in this lobby. This requires bearer token authentication.

  Parameters

  • 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>

delete

• delete(): Promise<void>

• Delete this lobby.

  Returns Promise<void>

edit

• edit(options): Promise<Lobby>

• Edit this lobby.

  Parameters

  • options: EditLobbyOptions

    The options for editing the lobby.

  Returns Promise<Lobby>

getMessages

• getMessages(options?, accessToken?): Promise<LobbyMessage[]>

• Get messages in this lobby. This requires bearer token authentication.

  Parameters

  • 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[]>

leave

• leave(accessToken?): Promise<void>

• Leave this lobby. This requires bearer token authentication.

  Parameters

  • Optional accessToken: string

    An optional access token to use instead of the client's token. This overrides the client's auth.

  Returns Promise<void>

linkChannel

• linkChannel(channelID, accessToken?): Promise<Lobby>

• Link this lobby to a channel. This requires bearer token authentication and the CAN_LINK_LOBBY flag on the member.

  Parameters

  • 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>

removeMember

• removeMember(userID): Promise<void>

• Remove a member from this lobby.

  Parameters

  • userID: string

    The ID of the user to remove from the lobby.

  Returns Promise<void>

toJSON

• toJSON(): JSONLobby

• Returns JSONLobby

unlinkChannel

• unlinkChannel(accessToken?): Promise<Lobby>

• Unlink this lobby from a channel. This requires bearer token authentication and the CAN_LINK_LOBBY flag on the member.

  Parameters

  • Optional accessToken: string

    An optional access token to use instead of the client's token. This overrides the client's auth.

  Returns Promise<Lobby>

updateMessageModerationMetadata

• updateMessageModerationMetadata(messageID, metadata): Promise<void>

• Update the moderation metadata for a message in this lobby.

  Parameters

  • 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>