Documentation

Google_Service_Directory_Resource_UsersAliases extends Google_Service_Resource
in package

The "aliases" collection of methods.

Typical usage is: $adminService = new Google_Service_Directory(...); $aliases = $adminService->aliases;

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.
delete()  : mixed
Remove a alias for the user (aliases.delete)
insert()  : Google_Service_Directory_Alias
Add a alias for the user (aliases.insert)
listUsersAliases()  : Google_Service_Directory_Aliases
List all aliases for a user (aliases.listUsersAliases)
watch()  : Google_Service_Directory_Channel
Watch for changes in users list (aliases.watch)
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

delete()

Remove a alias for the user (aliases.delete)

public delete(string $userKey, string $alias[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$userKey : string

Email or immutable ID of the user

$alias : string

The alias to be removed

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

Optional parameters.

Return values
mixed —

listUsersAliases()

List all aliases for a user (aliases.listUsersAliases)

public listUsersAliases(string $userKey[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Aliases
Parameters
$userKey : string

Email or immutable ID of the user

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

Optional parameters.

Return values
Google_Service_Directory_Aliases —

watch()

Watch for changes in users list (aliases.watch)

public watch(string $userKey, Google_Service_Directory_Channel $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_Channel
Parameters
$userKey : string

Email or immutable ID of the user

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

Optional parameters.

Tags
opt_param

string event Event on which subscription is intended (if subscribing)

Return values
Google_Service_Directory_Channel —

convertToArrayAndStripNulls()

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

Search results