Class TokenSourceRequest

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.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)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TokenSourceRequest()

public TokenSourceRequest()

TokenSourceRequest(TokenSourceRequest)

public TokenSourceRequest(TokenSourceRequest other)

Parameters

other TokenSourceRequest

Fields

ParticipantAttributesFieldNumber

Field number for the "participant_attributes" field.

public const int ParticipantAttributesFieldNumber = 5

Field Value

int

ParticipantIdentityFieldNumber

Field number for the "participant_identity" field.

public const int ParticipantIdentityFieldNumber = 3

Field Value

int

ParticipantMetadataFieldNumber

Field number for the "participant_metadata" field.

public const int ParticipantMetadataFieldNumber = 4

Field Value

int

ParticipantNameFieldNumber

Field number for the "participant_name" field.

public const int ParticipantNameFieldNumber = 2

Field Value

int

RoomConfigFieldNumber

Field number for the "room_config" field.

public const int RoomConfigFieldNumber = 6

Field Value

int

RoomNameFieldNumber

Field number for the "room_name" field.

public const int RoomNameFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

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

Parser

public static MessageParser<TokenSourceRequest> Parser { get; }

Property Value

MessageParser<TokenSourceRequest>

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

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

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()

Clone()

Creates a deep clone of this object.

public TokenSourceRequest Clone()

Returns

TokenSourceRequest

A deep clone of this object.

Equals(TokenSourceRequest)

public bool Equals(TokenSourceRequest other)

Parameters

other TokenSourceRequest

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(TokenSourceRequest)

Merges the given message into this one.

public void MergeFrom(TokenSourceRequest other)

Parameters

other TokenSourceRequest

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.