1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. UsersAliases

UsersAliases

class UsersAliases extends Resource (View source)

The "aliases" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $aliases = $adminService->users_aliases;

Methods

delete(string $userKey, string $alias, array $optParams = [])

Removes an alias. (aliases.delete)

Alias
insert(string $userKey, Alias $postBody, array $optParams = [])

Adds an alias. (aliases.insert)

Aliases
listUsersAliases(string $userKey, array $optParams = [])

Lists all aliases for a user. (aliases.listUsersAliases)

Channel
watch(string $userKey, Channel $postBody, array $optParams = [])

Watches for changes in users list. (aliases.watch)

Details

at line 43
delete(string $userKey, string $alias, array $optParams = [])

Removes an alias. (aliases.delete)

Parameters

string $userKey

Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
string $alias

The alias to be removed.
array $optParams

Optional parameters.

Exceptions

Exception

at line 59
Alias insert(string $userKey, Alias $postBody, array $optParams = [])

Adds an alias. (aliases.insert)

Parameters

string $userKey

Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
Alias $postBody
array $optParams

Optional parameters.

Return Value

Alias

Exceptions

Exception

at line 76
Aliases listUsersAliases(string $userKey, array $optParams = [])

Lists all aliases for a user. (aliases.listUsersAliases)

Parameters

string $userKey

Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
array $optParams

Optional parameters.

Return Value

Aliases

Exceptions

Exception

at line 93
Channel watch(string $userKey, Channel $postBody, array $optParams = [])

Watches for changes in users list. (aliases.watch)

Parameters

string $userKey

Email or immutable ID of the user
Channel $postBody
array $optParams

Optional parameters.

Return Value

Channel

Exceptions

Exception