Documentation

Google_Service_PostmasterTools_Resource_Domains extends Google_Service_Resource
in package

The "domains" collection of methods.

Typical usage is: $gmailpostmastertoolsService = new Google_Service_PostmasterTools(...); $domains = $gmailpostmastertoolsService->domains;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_PostmasterTools_Domain
Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist. (domains.get)
listDomains()  : Google_Service_PostmasterTools_ListDomainsResponse
Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist. (domains.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PostmasterTools_Domain
Parameters
$name : string

The resource name of the domain. It should have the form domains/{domain_name}, where domain_name is the fully qualified domain name.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_PostmasterTools_Domain —

listDomains()

Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.

public listDomains([array<string|int, mixed> $optParams = array() ]) : Google_Service_PostmasterTools_ListDomainsResponse

(domains.listDomains)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int pageSize Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.

opt_param

string pageToken The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to ListDomains method.

Return values
Google_Service_PostmasterTools_ListDomainsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results