Interface JoinOptions

Parameters used to join a channel.

interface JoinOptions {
    appid: string;
    channel: string;
    token: null | string;
    uid?: null | UID;
}

Properties

appid channel token uid?

Properties

appid

appid: string

The App ID of your Agora project.

channel

channel: string

The name of the channel to join. See IAgoraRTCClient.join for details.

token

token: null | string

The token used for authentication. If token-based authentication is enabled for your project, a valid token must be provided. If token-based authentication is not enabled, you can pass null. See IAgoraRTCClient.join for details.

Optional uid

uid?: null | UID

The user ID. If not provided, the Agora server assigns a number uid for you. See IAgoraRTCClient.join for details.

Settings

Member Visibility

Theme

On This Page

appidchanneltokenuid