Table of Contents

Class CreateSIPDispatchRuleRequest

Namespace
LiveKit.Proto
Assembly
LiveKit.AspNetCore.ServerSdk.Abstractions.dll
public sealed class CreateSIPDispatchRuleRequest : IMessage<CreateSIPDispatchRuleRequest>, IEquatable<CreateSIPDispatchRuleRequest>, IDeepCloneable<CreateSIPDispatchRuleRequest>, IBufferMessage, IMessage
Inheritance
CreateSIPDispatchRuleRequest
Implements
IBufferMessage
IMessage
Inherited Members

Constructors

CreateSIPDispatchRuleRequest()

public CreateSIPDispatchRuleRequest()

CreateSIPDispatchRuleRequest(CreateSIPDispatchRuleRequest)

public CreateSIPDispatchRuleRequest(CreateSIPDispatchRuleRequest other)

Parameters

other CreateSIPDispatchRuleRequest

Fields

AttributesFieldNumber

Field number for the "attributes" field.

public const int AttributesFieldNumber = 7

Field Value

int

DispatchRuleFieldNumber

Field number for the "dispatch_rule" field.

public const int DispatchRuleFieldNumber = 10

Field Value

int

HidePhoneNumberFieldNumber

Field number for the "hide_phone_number" field.

public const int HidePhoneNumberFieldNumber = 3

Field Value

int

InboundNumbersFieldNumber

Field number for the "inbound_numbers" field.

public const int InboundNumbersFieldNumber = 6

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 5

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 4

Field Value

int

RoomConfigFieldNumber

Field number for the "room_config" field.

public const int RoomConfigFieldNumber = 9

Field Value

int

RoomPresetFieldNumber

Field number for the "room_preset" field.

public const int RoomPresetFieldNumber = 8

Field Value

int

RuleFieldNumber

Field number for the "rule" field.

public const int RuleFieldNumber = 1

Field Value

int

TrunkIdsFieldNumber

Field number for the "trunk_ids" field.

public const int TrunkIdsFieldNumber = 2

Field Value

int

Properties

Attributes

User-defined attributes for the Dispatch Rule. Participants created by this rule will inherit these attributes.

[Obsolete]
public MapField<string, string> Attributes { get; }

Property Value

MapField<string, string>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DispatchRule

Rule ID is ignored

public SIPDispatchRuleInfo DispatchRule { get; set; }

Property Value

SIPDispatchRuleInfo

HidePhoneNumber

By default the From value (Phone number) is used for participant name/identity and added to attributes. If true, a random value for identity will be used and numbers will be omitted from attributes.

[Obsolete]
public bool HidePhoneNumber { get; set; }

Property Value

bool

InboundNumbers

Dispatch Rule will only accept a call made to these numbers (if set).

[Obsolete]
public RepeatedField<string> InboundNumbers { get; }

Property Value

RepeatedField<string>

Metadata

User-defined metadata for the Dispatch Rule. Participants created by this rule will inherit this metadata.

[Obsolete]
public string Metadata { get; set; }

Property Value

string

Name

Optional human-readable name for the Dispatch Rule.

[Obsolete]
public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<CreateSIPDispatchRuleRequest> Parser { get; }

Property Value

MessageParser<CreateSIPDispatchRuleRequest>

RoomConfig

RoomConfiguration to use if the participant initiates the room

[Obsolete]
public RoomConfiguration RoomConfig { get; set; }

Property Value

RoomConfiguration

RoomPreset

Cloud-only, config preset to use

[Obsolete]
public string RoomPreset { get; set; }

Property Value

string

Rule

[Obsolete]
public SIPDispatchRule Rule { get; set; }

Property Value

SIPDispatchRule

TrunkIds

What trunks are accepted for this dispatch rule If empty all trunks will match this dispatch rule

[Obsolete]
public RepeatedField<string> TrunkIds { get; }

Property Value

RepeatedField<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.

Clone()

Creates a deep clone of this object.

public CreateSIPDispatchRuleRequest Clone()

Returns

CreateSIPDispatchRuleRequest

A deep clone of this object.

Equals(CreateSIPDispatchRuleRequest)

public bool Equals(CreateSIPDispatchRuleRequest other)

Parameters

other CreateSIPDispatchRuleRequest

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

Merges the given message into this one.

public void MergeFrom(CreateSIPDispatchRuleRequest other)

Parameters

other CreateSIPDispatchRuleRequest

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.