Skip to main content
Version: 2.0.0

ConnectionOptions

ruvyrias


ruvyrias / ConnectionOptions

Interface: ConnectionOptions

Defined in: types/Ruvyrias.ts:127

Options for establishing a voice connection in Ruvyrias.

Properties

guildId

guildId: string

Defined in: types/Ruvyrias.ts:129

The unique identifier of the guild (server) where the connection is established.


region?

optional region: string

Defined in: types/Ruvyrias.ts:139

The preferred region for the voice connection.


selfDeaf?

optional selfDeaf: boolean

Defined in: types/Ruvyrias.ts:135

Indicates whether the bot should join the voice channel as selfDeafened.


selfMute?

optional selfMute: boolean

Defined in: types/Ruvyrias.ts:137

Indicates whether the bot should join the voice channel as selfMuted.


textChannelId

textChannelId: null | string

Defined in: types/Ruvyrias.ts:133

The ID of the text channel associated with the voice connection. Can be null if not applicable.


voiceChannelId

voiceChannelId: null | string

Defined in: types/Ruvyrias.ts:131

The ID of the voice channel to connect to. Can be null if disconnecting.