Documentation

ListPhoneNumbersRequest extends Message
in package

ListPhoneNumbersRequest - Request to list phone numbers

Generated from protobuf message livekit.ListPhoneNumbersRequest

Table of Contents

Properties

$limit  : mixed
Maximum number of results (default: 50)
$page_token  : mixed
Token for pagination (empty for first page)
$sip_dispatch_rule_id  : mixed
Filter by SIP dispatch rule ID
$statuses  : mixed
Filter by statuses (active, pending, released)

Methods

__construct()  : mixed
Constructor.
clearLimit()  : mixed
clearPageToken()  : mixed
clearSipDispatchRuleId()  : mixed
getLimit()  : int
Maximum number of results (default: 50)
getPageToken()  : TokenPagination|null
Token for pagination (empty for first page)
getSipDispatchRuleId()  : string
Filter by SIP dispatch rule ID
getStatuses()  : RepeatedField<string|int, int>
Filter by statuses (active, pending, released)
hasLimit()  : mixed
hasPageToken()  : mixed
hasSipDispatchRuleId()  : mixed
setLimit()  : $this
Maximum number of results (default: 50)
setPageToken()  : $this
Token for pagination (empty for first page)
setSipDispatchRuleId()  : $this
Filter by SIP dispatch rule ID
setStatuses()  : $this
Filter by statuses (active, pending, released)

Properties

$limit

Maximum number of results (default: 50)

protected mixed $limit = null

Generated from protobuf field optional int32 limit = 1;

$page_token

Token for pagination (empty for first page)

protected mixed $page_token = null

Generated from protobuf field optional .livekit.TokenPagination page_token = 3;

$sip_dispatch_rule_id

Filter by SIP dispatch rule ID

protected mixed $sip_dispatch_rule_id = null

Generated from protobuf field optional string sip_dispatch_rule_id = 4;

$statuses

Filter by statuses (active, pending, released)

private mixed $statuses

Generated from protobuf field repeated .livekit.PhoneNumberStatus statuses = 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 int $limit
      Maximum number of results (default: 50)
@type int[] $statuses
      Filter by statuses (active, pending, released)
@type \Livekit\TokenPagination $page_token
      Token for pagination (empty for first page)
@type string $sip_dispatch_rule_id
      Filter by SIP dispatch rule ID

}

getLimit()

Maximum number of results (default: 50)

public getLimit() : int

Generated from protobuf field optional int32 limit = 1;

Return values
int

getSipDispatchRuleId()

Filter by SIP dispatch rule ID

public getSipDispatchRuleId() : string

Generated from protobuf field optional string sip_dispatch_rule_id = 4;

Return values
string

getStatuses()

Filter by statuses (active, pending, released)

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

Generated from protobuf field repeated .livekit.PhoneNumberStatus statuses = 2;

Return values
RepeatedField<string|int, int>

setLimit()

Maximum number of results (default: 50)

public setLimit(int $var) : $this

Generated from protobuf field optional int32 limit = 1;

Parameters
$var : int
Return values
$this

setSipDispatchRuleId()

Filter by SIP dispatch rule ID

public setSipDispatchRuleId(string $var) : $this

Generated from protobuf field optional string sip_dispatch_rule_id = 4;

Parameters
$var : string
Return values
$this

setStatuses()

Filter by statuses (active, pending, released)

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

Generated from protobuf field repeated .livekit.PhoneNumberStatus statuses = 2;

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

        
On this page

Search results