Documentation

SIPDispatchRuleInfo extends Message
in package

Generated from protobuf message <code>livekit.SIPDispatchRuleInfo</code>

Table of Contents

Properties

$hide_phone_number  : mixed
Generated from protobuf field <code>bool hide_phone_number = 4;</code>
$krisp_enabled  : mixed
Generated from protobuf field <code>bool krisp_enabled = 11;</code>
$media_encryption  : mixed
NEXT ID: 13
$metadata  : mixed
User-defined metadata for the Dispatch Rule.
$name  : mixed
Human-readable name for the Dispatch Rule.
$room_config  : mixed
RoomConfiguration to use if the participant initiates the room
$room_preset  : mixed
Cloud-only, config preset to use
$rule  : mixed
Generated from protobuf field <code>.livekit.SIPDispatchRule rule = 2;</code>
$sip_dispatch_rule_id  : mixed
Generated from protobuf field <code>string sip_dispatch_rule_id = 1;</code>
$attributes  : mixed
User-defined attributes for the Dispatch Rule.
$inbound_numbers  : mixed
Dispatch Rule will only accept a call made to these numbers (if set).
$trunk_ids  : mixed
Generated from protobuf field <code>repeated string trunk_ids = 3;</code>

Methods

__construct()  : mixed
Constructor.
clearRoomConfig()  : mixed
clearRule()  : mixed
getAttributes()  : MapField
User-defined attributes for the Dispatch Rule.
getHidePhoneNumber()  : bool
Generated from protobuf field <code>bool hide_phone_number = 4;</code>
getInboundNumbers()  : RepeatedField<string|int, string>
Dispatch Rule will only accept a call made to these numbers (if set).
getKrispEnabled()  : bool
Generated from protobuf field <code>bool krisp_enabled = 11;</code>
getMediaEncryption()  : int
NEXT ID: 13
getMetadata()  : string
User-defined metadata for the Dispatch Rule.
getName()  : string
Human-readable name for the Dispatch Rule.
getRoomConfig()  : RoomConfiguration|null
RoomConfiguration to use if the participant initiates the room
getRoomPreset()  : string
Cloud-only, config preset to use
getRule()  : SIPDispatchRule|null
Generated from protobuf field <code>.livekit.SIPDispatchRule rule = 2;</code>
getSipDispatchRuleId()  : string
Generated from protobuf field <code>string sip_dispatch_rule_id = 1;</code>
getTrunkIds()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string trunk_ids = 3;</code>
hasRoomConfig()  : mixed
hasRule()  : mixed
setAttributes()  : $this
User-defined attributes for the Dispatch Rule.
setHidePhoneNumber()  : $this
Generated from protobuf field <code>bool hide_phone_number = 4;</code>
setInboundNumbers()  : $this
Dispatch Rule will only accept a call made to these numbers (if set).
setKrispEnabled()  : $this
Generated from protobuf field <code>bool krisp_enabled = 11;</code>
setMediaEncryption()  : $this
NEXT ID: 13
setMetadata()  : $this
User-defined metadata for the Dispatch Rule.
setName()  : $this
Human-readable name for the Dispatch Rule.
setRoomConfig()  : $this
RoomConfiguration to use if the participant initiates the room
setRoomPreset()  : $this
Cloud-only, config preset to use
setRule()  : $this
Generated from protobuf field <code>.livekit.SIPDispatchRule rule = 2;</code>
setSipDispatchRuleId()  : $this
Generated from protobuf field <code>string sip_dispatch_rule_id = 1;</code>
setTrunkIds()  : $this
Generated from protobuf field <code>repeated string trunk_ids = 3;</code>

Properties

$hide_phone_number

Generated from protobuf field <code>bool hide_phone_number = 4;</code>

protected mixed $hide_phone_number = false

$krisp_enabled

Generated from protobuf field <code>bool krisp_enabled = 11;</code>

protected mixed $krisp_enabled = false

$media_encryption

NEXT ID: 13

protected mixed $media_encryption = 0

Generated from protobuf field .livekit.SIPMediaEncryption media_encryption = 12;

$metadata

User-defined metadata for the Dispatch Rule.

protected mixed $metadata = ''

Participants created by this rule will inherit this metadata.

Generated from protobuf field string metadata = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$name

Human-readable name for the Dispatch Rule.

protected mixed $name = ''

Generated from protobuf field string name = 5;

$room_config

RoomConfiguration to use if the participant initiates the room

protected mixed $room_config = null

Generated from protobuf field .livekit.RoomConfiguration room_config = 10;

$room_preset

Cloud-only, config preset to use

protected mixed $room_preset = ''

Generated from protobuf field string room_preset = 9;

$rule

Generated from protobuf field <code>.livekit.SIPDispatchRule rule = 2;</code>

protected mixed $rule = null

$sip_dispatch_rule_id

Generated from protobuf field <code>string sip_dispatch_rule_id = 1;</code>

protected mixed $sip_dispatch_rule_id = ''

$attributes

User-defined attributes for the Dispatch Rule.

private mixed $attributes

Participants created by this rule will inherit these attributes.

Generated from protobuf field map<string, string> attributes = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$inbound_numbers

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

private mixed $inbound_numbers

Generated from protobuf field repeated string inbound_numbers = 7;

$trunk_ids

Generated from protobuf field <code>repeated string trunk_ids = 3;</code>

private mixed $trunk_ids

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type string $sip_dispatch_rule_id
@type \Livekit\SIPDispatchRule $rule
@type string[] $trunk_ids
@type bool $hide_phone_number
@type string[] $inbound_numbers
      Dispatch Rule will only accept a call made to these numbers (if set).
@type string $name
      Human-readable name for the Dispatch Rule.
@type string $metadata
      User-defined metadata for the Dispatch Rule.
      Participants created by this rule will inherit this metadata.
@type array|\Google\Protobuf\Internal\MapField $attributes
      User-defined attributes for the Dispatch Rule.
      Participants created by this rule will inherit these attributes.
@type string $room_preset
      Cloud-only, config preset to use
@type \Livekit\RoomConfiguration $room_config
      RoomConfiguration to use if the participant initiates the room
@type bool $krisp_enabled
@type int $media_encryption
      NEXT ID: 13

}

getAttributes()

User-defined attributes for the Dispatch Rule.

public getAttributes() : MapField

Participants created by this rule will inherit these attributes.

Generated from protobuf field map<string, string> attributes = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
MapField

getHidePhoneNumber()

Generated from protobuf field <code>bool hide_phone_number = 4;</code>

public getHidePhoneNumber() : bool
Return values
bool

getInboundNumbers()

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

public getInboundNumbers() : RepeatedField<string|int, string>

Generated from protobuf field repeated string inbound_numbers = 7;

Return values
RepeatedField<string|int, string>

getKrispEnabled()

Generated from protobuf field <code>bool krisp_enabled = 11;</code>

public getKrispEnabled() : bool
Return values
bool

getMediaEncryption()

NEXT ID: 13

public getMediaEncryption() : int

Generated from protobuf field .livekit.SIPMediaEncryption media_encryption = 12;

Return values
int

getMetadata()

User-defined metadata for the Dispatch Rule.

public getMetadata() : string

Participants created by this rule will inherit this metadata.

Generated from protobuf field string metadata = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getName()

Human-readable name for the Dispatch Rule.

public getName() : string

Generated from protobuf field string name = 5;

Return values
string

getRoomPreset()

Cloud-only, config preset to use

public getRoomPreset() : string

Generated from protobuf field string room_preset = 9;

Return values
string

getSipDispatchRuleId()

Generated from protobuf field <code>string sip_dispatch_rule_id = 1;</code>

public getSipDispatchRuleId() : string
Return values
string

getTrunkIds()

Generated from protobuf field <code>repeated string trunk_ids = 3;</code>

public getTrunkIds() : RepeatedField<string|int, string>
Return values
RepeatedField<string|int, string>

setAttributes()

User-defined attributes for the Dispatch Rule.

public setAttributes(array<string|int, mixed>|MapField $var) : $this

Participants created by this rule will inherit these attributes.

Generated from protobuf field map<string, string> attributes = 8 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : array<string|int, mixed>|MapField
Return values
$this

setHidePhoneNumber()

Generated from protobuf field <code>bool hide_phone_number = 4;</code>

public setHidePhoneNumber(bool $var) : $this
Parameters
$var : bool
Return values
$this

setInboundNumbers()

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

public setInboundNumbers(array<string|int, string> $var) : $this

Generated from protobuf field repeated string inbound_numbers = 7;

Parameters
$var : array<string|int, string>
Return values
$this

setKrispEnabled()

Generated from protobuf field <code>bool krisp_enabled = 11;</code>

public setKrispEnabled(bool $var) : $this
Parameters
$var : bool
Return values
$this

setMediaEncryption()

NEXT ID: 13

public setMediaEncryption(int $var) : $this

Generated from protobuf field .livekit.SIPMediaEncryption media_encryption = 12;

Parameters
$var : int
Return values
$this

setMetadata()

User-defined metadata for the Dispatch Rule.

public setMetadata(string $var) : $this

Participants created by this rule will inherit this metadata.

Generated from protobuf field string metadata = 6 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setName()

Human-readable name for the Dispatch Rule.

public setName(string $var) : $this

Generated from protobuf field string name = 5;

Parameters
$var : string
Return values
$this

setRoomConfig()

RoomConfiguration to use if the participant initiates the room

public setRoomConfig(RoomConfiguration $var) : $this

Generated from protobuf field .livekit.RoomConfiguration room_config = 10;

Parameters
$var : RoomConfiguration
Return values
$this

setRoomPreset()

Cloud-only, config preset to use

public setRoomPreset(string $var) : $this

Generated from protobuf field string room_preset = 9;

Parameters
$var : string
Return values
$this

setSipDispatchRuleId()

Generated from protobuf field <code>string sip_dispatch_rule_id = 1;</code>

public setSipDispatchRuleId(string $var) : $this
Parameters
$var : string
Return values
$this

setTrunkIds()

Generated from protobuf field <code>repeated string trunk_ids = 3;</code>

public setTrunkIds(array<string|int, string> $var) : $this
Parameters
$var : array<string|int, string>
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results