Documentation

CreateSIPDispatchRuleRequest extends Message
in package

Application

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

Properties

$dispatch_rule : mixed: Rule ID is ignored
$hide_phone_number : mixed: By default the From value (Phone number) is used for participant name/identity and added to attributes.
$metadata : mixed: User-defined metadata for the Dispatch Rule.
$name : mixed: Optional 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 = 1 [deprecated = true];</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: What trunks are accepted for this dispatch rule If empty all trunks will match this dispatch rule

Methods

__construct() : mixed: Constructor.
clearDispatchRule() : mixed
clearRoomConfig() : mixed
clearRule() : mixed
getAttributes() : MapField: User-defined attributes for the Dispatch Rule.
getDispatchRule() : SIPDispatchRuleInfo|null: Rule ID is ignored
getHidePhoneNumber() : bool: By default the From value (Phone number) is used for participant name/identity and added to attributes.
getInboundNumbers() : RepeatedField<string|int, string>: Dispatch Rule will only accept a call made to these numbers (if set).
getMetadata() : string: User-defined metadata for the Dispatch Rule.
getName() : string: Optional 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 = 1 [deprecated = true];</code>
getTrunkIds() : RepeatedField<string|int, string>: What trunks are accepted for this dispatch rule If empty all trunks will match this dispatch rule
hasDispatchRule() : mixed
hasRoomConfig() : mixed
hasRule() : mixed
setAttributes() : $this: User-defined attributes for the Dispatch Rule.
setDispatchRule() : $this: Rule ID is ignored
setHidePhoneNumber() : $this: By default the From value (Phone number) is used for participant name/identity and added to attributes.
setInboundNumbers() : $this: Dispatch Rule will only accept a call made to these numbers (if set).
setMetadata() : $this: User-defined metadata for the Dispatch Rule.
setName() : $this: Optional 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 = 1 [deprecated = true];</code>
setTrunkIds() : $this: What trunks are accepted for this dispatch rule If empty all trunks will match this dispatch rule

$dispatch_rule

Rule ID is ignored


        protected
            mixed
    $dispatch_rule
     = null

Generated from protobuf field .livekit.SIPDispatchRuleInfo dispatch_rule = 10;

$hide_phone_number

By default the From value (Phone number) is used for participant name/identity and added to attributes.


        protected
            mixed
    $hide_phone_number
     = false

If true, a random value for identity will be used and numbers will be omitted from attributes.

Generated from protobuf field bool hide_phone_number = 3 [deprecated = true];

$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 = 5 [deprecated = true, (.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$name

Optional human-readable name for the Dispatch Rule.


        protected
            mixed
    $name
     = ''

Generated from protobuf field string name = 4 [deprecated = true];

$room_config

RoomConfiguration to use if the participant initiates the room


        protected
            mixed
    $room_config
     = null

Generated from protobuf field .livekit.RoomConfiguration room_config = 9 [deprecated = true];

$room_preset

Cloud-only, config preset to use


        protected
            mixed
    $room_preset
     = ''

Generated from protobuf field string room_preset = 8 [deprecated = true];

$rule

Generated from protobuf field <code>.livekit.SIPDispatchRule rule = 1 [deprecated = true];</code>


        protected
            mixed
    $rule
     = null

$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 = 7 [deprecated = true, (.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 = 6 [deprecated = true];

$trunk_ids

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


        private
            mixed
    $trunk_ids

Generated from protobuf field repeated string trunk_ids = 2 [deprecated = true];

__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 \Livekit\SIPDispatchRuleInfo $dispatch_rule
      Rule ID is ignored
@type \Livekit\SIPDispatchRule $rule
@type string[] $trunk_ids
      What trunks are accepted for this dispatch rule
      If empty all trunks will match this dispatch rule
@type bool $hide_phone_number
      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.
@type string[] $inbound_numbers
      Dispatch Rule will only accept a call made to these numbers (if set).
@type string $name
      Optional 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

}

clearDispatchRule()


    public
                    clearDispatchRule() : mixed

clearRoomConfig()


    public
                    clearRoomConfig() : mixed

clearRule()


    public
                    clearRule() : mixed

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 = 7 [deprecated = true, (.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values

MapField

getDispatchRule()

Rule ID is ignored


    public
                    getDispatchRule() : SIPDispatchRuleInfo|null

Generated from protobuf field .livekit.SIPDispatchRuleInfo dispatch_rule = 10;

Return values

SIPDispatchRuleInfo|null

getHidePhoneNumber()

By default the From value (Phone number) is used for participant name/identity and added to attributes.


    public
                    getHidePhoneNumber() : bool

If true, a random value for identity will be used and numbers will be omitted from attributes.

Generated from protobuf field bool hide_phone_number = 3 [deprecated = true];

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 = 6 [deprecated = true];

Return values

RepeatedField<string|int, string>

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 = 5 [deprecated = true, (.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values

string

getName()

Optional human-readable name for the Dispatch Rule.


    public
                    getName() : string

Generated from protobuf field string name = 4 [deprecated = true];

Return values

string

getRoomConfig()

RoomConfiguration to use if the participant initiates the room


    public
                    getRoomConfig() : RoomConfiguration|null

Generated from protobuf field .livekit.RoomConfiguration room_config = 9 [deprecated = true];

Return values

RoomConfiguration|null

getRoomPreset()

Cloud-only, config preset to use


    public
                    getRoomPreset() : string

Generated from protobuf field string room_preset = 8 [deprecated = true];

Return values

string

getRule()

Generated from protobuf field <code>.livekit.SIPDispatchRule rule = 1 [deprecated = true];</code>


    public
                    getRule() : SIPDispatchRule|null

Return values

SIPDispatchRule|null

getTrunkIds()

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


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

Generated from protobuf field repeated string trunk_ids = 2 [deprecated = true];

Return values

RepeatedField<string|int, string>

hasDispatchRule()


    public
                    hasDispatchRule() : mixed

hasRoomConfig()


    public
                    hasRoomConfig() : mixed

hasRule()


    public
                    hasRule() : mixed

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 = 7 [deprecated = true, (.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters

$var : array<string|int, mixed>|MapField

Return values

$this

setDispatchRule()

Rule ID is ignored


    public
                    setDispatchRule(SIPDispatchRuleInfo $var) : $this

Generated from protobuf field .livekit.SIPDispatchRuleInfo dispatch_rule = 10;

Parameters

$var : SIPDispatchRuleInfo

Return values

$this

setHidePhoneNumber()

By default the From value (Phone number) is used for participant name/identity and added to attributes.


    public
                    setHidePhoneNumber(bool $var) : $this

If true, a random value for identity will be used and numbers will be omitted from attributes.

Generated from protobuf field bool hide_phone_number = 3 [deprecated = true];

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 = 6 [deprecated = true];

Parameters

$var : array<string|int, string>

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 = 5 [deprecated = true, (.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters

$var : string

Return values

$this

setName()

Optional human-readable name for the Dispatch Rule.


    public
                    setName(string $var) : $this

Generated from protobuf field string name = 4 [deprecated = true];

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 = 9 [deprecated = true];

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 = 8 [deprecated = true];

Parameters

$var : string

Return values

$this

setRule()

Generated from protobuf field <code>.livekit.SIPDispatchRule rule = 1 [deprecated = true];</code>


    public
                    setRule(SIPDispatchRule $var) : $this

Parameters

$var : SIPDispatchRule

Return values

$this

setTrunkIds()

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


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

Generated from protobuf field repeated string trunk_ids = 2 [deprecated = true];

Parameters

$var : array<string|int, string>

Return values

$this

CreateSIPDispatchRuleRequest extends Message in package Application

Table of Contents

Properties

Methods

Properties

$dispatch_rule

$hide_phone_number

$metadata

$name

$room_config

$room_preset

$rule

$attributes

$inbound_numbers

$trunk_ids

Methods

__construct()

Parameters

clearDispatchRule()

clearRoomConfig()

clearRule()

getAttributes()

Return values

getDispatchRule()

Return values

getHidePhoneNumber()

Return values

getInboundNumbers()

Return values

getMetadata()

Return values

getName()

Return values

getRoomConfig()

Return values

getRoomPreset()

Return values

getRule()

Return values

getTrunkIds()

Return values

hasDispatchRule()

hasRoomConfig()

hasRule()

setAttributes()

Parameters

Return values

setDispatchRule()

Parameters

Return values

setHidePhoneNumber()

Parameters

Return values

setInboundNumbers()

Parameters

Return values

setMetadata()

Parameters

Return values

setName()

Parameters

Return values

setRoomConfig()

Parameters

Return values

setRoomPreset()

Parameters

Return values

setRule()

Parameters

Return values

setTrunkIds()

Parameters

Return values

CreateSIPDispatchRuleRequest extends Message
in package

Application