APILobby

Index

Properties

• application_id
• capacity
• id
• locked
• metadata
• owner_id
• region
• secret
• type

Properties

application_id

application_id: string

Unique id of the application

capacity

capacity: number

The maximum capacity of this lobby

@default

16

id

id: string

Unique id of this lobby

locked

locked: boolean

Whether this lobby can be joined

metadata

metadata: Record<string, string>

Metadata for this lobby. key/value pairs with type string

owner_id

owner_id: string

The user id of the lobby owner

region

region: LobbyRegion

The region of this lobby. Defaults the region of the requesting server’s IP address

secret

secret: string

The password of this lobby

type

type: LobbyType

The type of this lobby (whether it is private or public)