Documentation

ListSIPDispatchRuleRequest extends Message
in package

ListSIPDispatchRuleRequest lists dispatch rules for given filters. If no filters are set, all rules are listed.

Generated from protobuf message livekit.ListSIPDispatchRuleRequest

Table of Contents

Properties

$page  : mixed
Generated from protobuf field <code>.livekit.Pagination page = 3;</code>
$dispatch_rule_ids  : mixed
Rule IDs to list. If this option is set, the response will contains rules in the same order.
$trunk_ids  : mixed
Only list rules that contain one of the Trunk IDs, including wildcard rules.

Methods

__construct()  : mixed
Constructor.
clearPage()  : mixed
getDispatchRuleIds()  : RepeatedField<string|int, string>
Rule IDs to list. If this option is set, the response will contains rules in the same order.
getPage()  : Pagination|null
Generated from protobuf field <code>.livekit.Pagination page = 3;</code>
getTrunkIds()  : RepeatedField<string|int, string>
Only list rules that contain one of the Trunk IDs, including wildcard rules.
hasPage()  : mixed
setDispatchRuleIds()  : $this
Rule IDs to list. If this option is set, the response will contains rules in the same order.
setPage()  : $this
Generated from protobuf field <code>.livekit.Pagination page = 3;</code>
setTrunkIds()  : $this
Only list rules that contain one of the Trunk IDs, including wildcard rules.

Properties

$dispatch_rule_ids

Rule IDs to list. If this option is set, the response will contains rules in the same order.

private mixed $dispatch_rule_ids

If any of the rules is missing, a nil item in that position will be sent in the response.

Generated from protobuf field repeated string dispatch_rule_ids = 1;

$trunk_ids

Only list rules that contain one of the Trunk IDs, including wildcard rules.

private mixed $trunk_ids

Generated from protobuf field repeated string trunk_ids = 2;

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 \Livekit\Pagination $page
@type string[] $dispatch_rule_ids
      Rule IDs to list. If this option is set, the response will contains rules in the same order.
      If any of the rules is missing, a nil item in that position will be sent in the response.
@type string[] $trunk_ids
      Only list rules that contain one of the Trunk IDs, including wildcard rules.

}

getDispatchRuleIds()

Rule IDs to list. If this option is set, the response will contains rules in the same order.

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

If any of the rules is missing, a nil item in that position will be sent in the response.

Generated from protobuf field repeated string dispatch_rule_ids = 1;

Return values
RepeatedField<string|int, string>

getTrunkIds()

Only list rules that contain one of the Trunk IDs, including wildcard rules.

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

Generated from protobuf field repeated string trunk_ids = 2;

Return values
RepeatedField<string|int, string>

setDispatchRuleIds()

Rule IDs to list. If this option is set, the response will contains rules in the same order.

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

If any of the rules is missing, a nil item in that position will be sent in the response.

Generated from protobuf field repeated string dispatch_rule_ids = 1;

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

setTrunkIds()

Only list rules that contain one of the Trunk IDs, including wildcard rules.

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

Generated from protobuf field repeated string trunk_ids = 2;

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results