Skip to content
Last Updated
Mar 28, 2025, 03:08

Class Lobby ​

🏭 Constructors ​

constructor ​

ts
Lobby(client: Client, props: Record<string, any>): Lobby

Parameters ​

  • client: Client
  • props: Record<string, any>

Return Type ​

  • Lobby

Defined in: packages/discord-rpc/structures/Lobby.ts:25

🏷️ Properties ​

application_id ​

ts
application_id: string

Defined in: packages/discord-rpc/structures/Lobby.ts:13

capacity ​

ts
capacity: number

Defined in: packages/discord-rpc/structures/Lobby.ts:14

client ​

ts
client: Client

the client instance Inherited from: Base.client

Defined in: packages/discord-rpc/structures/Base.ts:7

id ​

ts
id: string

Defined in: packages/discord-rpc/structures/Lobby.ts:15

locked ​

ts
locked: boolean

Defined in: packages/discord-rpc/structures/Lobby.ts:16

members ​

ts
members: { metadata: any; user: User }[]

Defined in: packages/discord-rpc/structures/Lobby.ts:17

metadata ​

ts
metadata: any

Defined in: packages/discord-rpc/structures/Lobby.ts:18

owner_id ​

ts
owner_id: string

Defined in: packages/discord-rpc/structures/Lobby.ts:19

region ​

ts
region: string

Defined in: packages/discord-rpc/structures/Lobby.ts:20

secret ​

ts
secret: string

Defined in: packages/discord-rpc/structures/Lobby.ts:21

type ​

ts
type: LobbyType

Defined in: packages/discord-rpc/structures/Lobby.ts:22

voice_states ​

ts
voice_states: GatewayVoiceState

Defined in: packages/discord-rpc/structures/Lobby.ts:23

🔧 Methods ​

delete ​

ts
delete(): Promise<void>

Return Type ​

  • Promise<void>

Defined in: packages/discord-rpc/structures/Lobby.ts:81

disconnect ​

ts
disconnect(): Promise<void>

Return Type ​

  • Promise<void>

Defined in: packages/discord-rpc/structures/Lobby.ts:77

joinVoice ​

ts
joinVoice(): Promise<void>

Return Type ​

  • Promise<void>

Defined in: packages/discord-rpc/structures/Lobby.ts:42

leaveVoice ​

ts
leaveVoice(): Promise<void>

Return Type ​

  • Promise<void>

Defined in: packages/discord-rpc/structures/Lobby.ts:46

update ​

ts
update(type: LobbyType, owner_id: string, capacity: number, locked: boolean, metadata: any): Promise<void>

Parameters ​

  • type: LobbyType
  • owner_id: string
  • capacity: number
  • locked: boolean
  • metadata: any

Return Type ​

  • Promise<void>

Defined in: packages/discord-rpc/structures/Lobby.ts:50

updateMember ​

ts
updateMember(userId: string, metadata: any): Promise<void>

Parameters ​

  • userId: string
  • metadata: any

Return Type ​

  • Promise<void>

Defined in: packages/discord-rpc/structures/Lobby.ts:73