Class AgoraUserTokenParams

Defined in File Authentication.h

Class Documentation

class AgoraUserTokenParams

Data structure for an Agora user token, giving userID, referenceID, channel name and settings regarding sharing of audio/video/screenshare.

Public Members

csp::common::String AgoraUserId: The unique identifer for the user requesting the token.

csp::common::String ChannelName

The unique name for the Agora channel being joined.

It can be set to any string combination. For group calls all users must reference the same channelName.

csp::common::String ReferenceId

The unique identfier for the space being joined.

Only needs to be set if the channelName is not set to the space ID, so the appropriate permissions can be requested. It can be set to an empty string if not required.

int Lifespan: The amount of time the token is valid for in milliseconds.

bool ReadOnly: If the token is ready only.

bool ShareAudio: If the token is configured for sharing of audio.

bool ShareVideo: If the token is configured for sharing of video.

bool ShareScreen: If the token is configured for sharing of the user’s screen.