Class TokenSourceRequest

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

public sealed class TokenSourceRequest : IMessage<TokenSourceRequest>, IEquatable<TokenSourceRequest>, IDeepCloneable<TokenSourceRequest>, IBufferMessage, IMessage

Inheritance

object

TokenSourceRequest

Implements

IMessage<TokenSourceRequest>

IEquatable<TokenSourceRequest>

IDeepCloneable<TokenSourceRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TokenSourceRequest()

public TokenSourceRequest()

TokenSourceRequest(TokenSourceRequest)

public TokenSourceRequest(TokenSourceRequest other)

Parameters

other TokenSourceRequest

Properties

HasParticipantIdentity

Gets whether the "participant_identity" field is set

public bool HasParticipantIdentity { get; }

Property Value

bool

HasParticipantMetadata

Gets whether the "participant_metadata" field is set

public bool HasParticipantMetadata { get; }

Property Value

bool

HasParticipantName

Gets whether the "participant_name" field is set

public bool HasParticipantName { get; }

Property Value

bool

HasRoomName

Gets whether the "room_name" field is set

public bool HasRoomName { get; }

Property Value

bool

ParticipantAttributes

Any participant attributes being included along with the credentials generation operation

public MapField<string, string> ParticipantAttributes { get; }

Property Value

MapField<string, string>

ParticipantIdentity

The identity of the participant being requested for this client when generating credentials

public string ParticipantIdentity { get; set; }

Property Value

string

ParticipantMetadata

Any participant metadata being included along with the credentials generation operation

public string ParticipantMetadata { get; set; }

Property Value

string

ParticipantName

The name of the participant being requested for this client when generating credentials

public string ParticipantName { get; set; }

Property Value

string

RoomConfig

A RoomConfiguration object can be passed to request extra parameters should be included when generating connection credentials - dispatching agents, defining egress settings, etc More info: https://docs.livekit.io/home/get-started/authentication/#room-configuration

public RoomConfiguration RoomConfig { get; set; }

Property Value

RoomConfiguration

RoomName

The name of the room being requested when generating credentials

public string RoomName { get; set; }

Property Value

string

Methods

ClearParticipantIdentity()

Clears the value of the "participant_identity" field

public void ClearParticipantIdentity()

ClearParticipantMetadata()

Clears the value of the "participant_metadata" field

public void ClearParticipantMetadata()

ClearParticipantName()

Clears the value of the "participant_name" field

public void ClearParticipantName()

ClearRoomName()

Clears the value of the "room_name" field

public void ClearRoomName()