Interface JoinLobbyOptions

interface JoinLobbyOptions {
    accessToken?: string;
    flags?: number;
    idleTimeoutSeconds?: number;
    lobbyMetadata?: null | Record<string, string>;
    memberMetadata?: null | Record<string, string>;
    secret: string;
}

Properties

accessToken? flags? idleTimeoutSeconds? lobbyMetadata? memberMetadata? secret

Properties

Optional accessToken

accessToken?: string

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

Optional flags

flags?: number

The lobby flags.

Optional idleTimeoutSeconds

idleTimeoutSeconds?: number

How long to wait (in seconds) before shutting down a lobby after it becomes idle.

Optional lobbyMetadata

lobbyMetadata?: null | Record<string, string>

The metadata of the lobby.

Optional memberMetadata

memberMetadata?: null | Record<string, string>

The metadata of the current lobby member.

secret

secret: string

The lobby secret.

Settings

Member Visibility

Theme

On This Page

accessTokenflagsidleTimeoutSecondslobbyMetadatamemberMetadatasecret