Class: LiveEndpoint

Defined in: endpoints/live.ts:5

Constructors

Constructor

new LiveEndpoint(client): LiveEndpoint;

Defined in: endpoints/live.ts:6

Parameters

Parameter	Type
client	RESTClient

Returns

LiveEndpoint

Methods

getChannelLiveData()

getChannelLiveData(channelId): Promise<IChannelLiveResponse>;

Defined in: endpoints/live.ts:32

Parameters

Parameter	Type
channelId	number

Returns

Promise<IChannelLiveResponse>

---

getLivekitToken()

getLivekitToken(channelId): Promise<ILivekitTokenResponse>;

Defined in: endpoints/live.ts:28

Parameters

Parameter	Type
channelId	number

Returns

Promise<ILivekitTokenResponse>

---

getPrivateLiveData()

getPrivateLiveData(): Promise<IChannelLiveResponse>;

Defined in: endpoints/live.ts:36

Returns

Promise<IChannelLiveResponse>

---

getServerLiveData()

getServerLiveData(serverId): Promise<IChannelLiveResponse>;

Defined in: endpoints/live.ts:40

Parameters

Parameter	Type
serverId	number

Returns

Promise<IChannelLiveResponse>

---

getServersLiveData()

getServersLiveData(): Promise<IChannelLiveResponse>;

Defined in: endpoints/live.ts:45

calls running in every server the user is in, each channel carrying its serverId

Returns

Promise<IChannelLiveResponse>

---

moveMember()

moveMember(
   sourceChannelId, 
   channelId, 
   userId
): Promise<{
  success: boolean;
}>;

Defined in: endpoints/live.ts:21

Parameters

Parameter	Type
sourceChannelId	number
channelId	number
userId	number

Returns

Promise<{ success: boolean; }>

---

releaseTemporaryAccess()

releaseTemporaryAccess(channelId): Promise<{
  success: boolean;
}>;

Defined in: endpoints/live.ts:24

Parameters

Parameter	Type
channelId	number

Returns

Promise<{ success: boolean; }>

---

setAfk()

setAfk(channelId, isAfk): Promise<{
  success: boolean;
}>;

Defined in: endpoints/live.ts:9

Publish your own AFK indicator while connected to this voice channel.

Parameters

Parameter	Type
channelId	number
isAfk	boolean

Returns

Promise<{ success: boolean; }>

---

setVoiceState()

setVoiceState(channelId, state): Promise<IVoiceState & object>;

Defined in: endpoints/live.ts:14

Publish your own microphone/deafen indicators for everyone who can see the call.

Parameters

Parameter	Type
channelId	number
state	IVoiceState & object

Returns

Promise<IVoiceState & object>