Documentation

SearchPhoneNumbersRequest extends Message
in package

SearchPhoneNumbersRequest - Request to search available phone numbers

Generated from protobuf message livekit.SearchPhoneNumbersRequest

Table of Contents

Properties

$area_code  : mixed
Filter by area code (e.g., "415")
$country_code  : mixed
Filter by country code (e.g., "US", "CA")
$limit  : mixed
Maximum number of results (default: 50)
$page_token  : mixed
Token for pagination (empty for first page)

Methods

__construct()  : mixed
Constructor.
clearAreaCode()  : mixed
clearLimit()  : mixed
clearPageToken()  : mixed
getAreaCode()  : string
Filter by area code (e.g., "415")
getCountryCode()  : string
Filter by country code (e.g., "US", "CA")
getLimit()  : int
Maximum number of results (default: 50)
getPageToken()  : TokenPagination|null
Token for pagination (empty for first page)
hasAreaCode()  : mixed
hasLimit()  : mixed
hasPageToken()  : mixed
setAreaCode()  : $this
Filter by area code (e.g., "415")
setCountryCode()  : $this
Filter by country code (e.g., "US", "CA")
setLimit()  : $this
Maximum number of results (default: 50)
setPageToken()  : $this
Token for pagination (empty for first page)

Properties

$area_code

Filter by area code (e.g., "415")

protected mixed $area_code = null

Generated from protobuf field optional string area_code = 2;

$country_code

Filter by country code (e.g., "US", "CA")

protected mixed $country_code = ''

Generated from protobuf field string country_code = 1;

$limit

Maximum number of results (default: 50)

protected mixed $limit = null

Generated from protobuf field optional int32 limit = 3;

$page_token

Token for pagination (empty for first page)

protected mixed $page_token = null

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

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 $country_code
      Filter by country code (e.g., "US", "CA")
@type string $area_code
      Filter by area code (e.g., "415")
@type int $limit
      Maximum number of results (default: 50)
@type \Livekit\TokenPagination $page_token
      Token for pagination (empty for first page)

}

getAreaCode()

Filter by area code (e.g., "415")

public getAreaCode() : string

Generated from protobuf field optional string area_code = 2;

Return values
string

getCountryCode()

Filter by country code (e.g., "US", "CA")

public getCountryCode() : string

Generated from protobuf field string country_code = 1;

Return values
string

getLimit()

Maximum number of results (default: 50)

public getLimit() : int

Generated from protobuf field optional int32 limit = 3;

Return values
int

setAreaCode()

Filter by area code (e.g., "415")

public setAreaCode(string $var) : $this

Generated from protobuf field optional string area_code = 2;

Parameters
$var : string
Return values
$this

setCountryCode()

Filter by country code (e.g., "US", "CA")

public setCountryCode(string $var) : $this

Generated from protobuf field string country_code = 1;

Parameters
$var : string
Return values
$this

setLimit()

Maximum number of results (default: 50)

public setLimit(int $var) : $this

Generated from protobuf field optional int32 limit = 3;

Parameters
$var : int
Return values
$this

        
On this page

Search results