Documentation

Google_Service_CloudIdentity_Resource_DevicesDeviceUsersClientStates extends Google_Service_Resource
in package

The "clientStates" collection of methods.

Typical usage is: $cloudidentityService = new Google_Service_CloudIdentity(...); $clientStates = $cloudidentityService->clientStates;

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_CloudIdentity_GoogleAppsCloudidentityDevicesV1ClientState
Gets the client state for the device user (clientStates.get)
listDevicesDeviceUsersClientStates()  : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListClientStatesResponse
Lists the client states for the given search query.
patch()  : Google_Service_CloudIdentity_Operation
Updates the client state for the device user (clientStates.patch)
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 the client state for the device user (clientStates.get)

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

Required. Resource name of the ClientState in format: devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{partner_id}, where device_id is the unique ID assigned to the Device, device_user_id is the unique ID assigned to the User and partner_id identifies the partner storing the data.

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

Optional parameters.

Tags
opt_param

string customer Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

Return values
Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ClientState —

listDevicesDeviceUsersClientStates()

Lists the client states for the given search query.

public listDevicesDeviceUsersClientStates(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListClientStatesResponse

(clientStates.listDevicesDeviceUsersClientStates)

Parameters
$parent : string

Required. To list all ClientStates, set this to "devices/-/deviceUsers/-". To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser}

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

Optional parameters.

Tags
opt_param

string customer Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

opt_param

string filter Optional. Additional restrictions when fetching list of client states.

opt_param

string pageToken Optional. A page token, received from a previous ListClientStates call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListClientStates must match the call that provided the page token.

opt_param

string orderBy Optional. Order specification for client states in the response.

Return values
Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ListClientStatesResponse —

patch()

Updates the client state for the device user (clientStates.patch)

public patch(string $name, Google_Service_CloudIdentity_GoogleAppsCloudidentityDevicesV1ClientState $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudIdentity_Operation
Parameters
$name : string

Output only. Resource name of the ClientState in format: devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: {customer_id}-suffix, where customer_id is your customer ID. The suffix is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: GET https://www.googleapis.com/admin/directory/v1/customers/my_customer The id field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')

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

Optional parameters.

Tags
opt_param

string updateMask Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.

opt_param

string customer Required. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.

Return values
Google_Service_CloudIdentity_Operation —

convertToArrayAndStripNulls()

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

Search results