Documentation

Google_Service_Directory_Resource_Users extends Google_Service_Resource
in package

Application

The "users" collection of methods.

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

$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: Delete user (users.delete)
get() : Google_Service_Directory_User: retrieve user (users.get)
insert() : Google_Service_Directory_User: create user. (users.insert)
listUsers() : Google_Service_Directory_Users: Retrieve either deleted users or all users in a domain (paginated) (users.listUsers)
makeAdmin() : mixed: change admin status of a user (users.makeAdmin)
patch() : Google_Service_Directory_User: Patch Users via Apiary Patch Orchestration (users.patch)
signOut() : mixed: Sign a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again. (users.signOut)
undelete() : mixed: Undelete a deleted user (users.undelete)
update() : Google_Service_Directory_User: update user (users.update)
watch() : Google_Service_Directory_Channel: Watch for changes in users list (users.watch)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$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'))

__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

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>

Return values

string —

$requestUrl

delete()

Delete user (users.delete)


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

Parameters

$userKey : string: Email or immutable ID of the user
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

retrieve user (users.get)


    public
                get(string $userKey[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_User

Parameters

$userKey : string: Email or immutable ID of the user
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_User —

insert()

create user. (users.insert)


    public
                insert(Google_Service_Directory_User $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_User

Parameters

$postBody : Google_Service_Directory_User
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_User —

listUsers()

Retrieve either deleted users or all users in a domain (paginated) (users.listUsers)


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

Parameters

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

Return values

Google_Service_Directory_Users —

makeAdmin()

change admin status of a user (users.makeAdmin)


    public
                makeAdmin(string $userKey, Google_Service_Directory_UserMakeAdmin $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$userKey : string: Email or immutable ID of the user as admin
$postBody : Google_Service_Directory_UserMakeAdmin
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

patch()

Patch Users via Apiary Patch Orchestration (users.patch)


    public
                patch(string $userKey, Google_Service_Directory_User $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_User

Parameters

$userKey : string: Email or immutable ID of the user. If ID, it should match with id of user object
$postBody : Google_Service_Directory_User
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_User —

signOut()

Sign a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again. (users.signOut)


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

Parameters

$userKey : string: Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

undelete()

Undelete a deleted user (users.undelete)


    public
                undelete(string $userKey, Google_Service_Directory_UserUndelete $postBody[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$userKey : string: The immutable id of the user
$postBody : Google_Service_Directory_UserUndelete
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

update()

update user (users.update)


    public
                update(string $userKey, Google_Service_Directory_User $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Directory_User

Parameters

$userKey : string: Email or immutable ID of the user. If ID, it should match with id of user object
$postBody : Google_Service_Directory_User
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Directory_User —

watch()

Watch for changes in users list (users.watch)


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

Parameters

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

Return values

Google_Service_Directory_Channel —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —