Documentation

Google_Service_AndroidEnterprise_Resource_Entitlements extends Google_Service_Resource
in package

The "entitlements" collection of methods.

Typical usage is: $androidenterpriseService = new Google_Service_AndroidEnterprise(...); $entitlements = $androidenterpriseService->entitlements;

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
Removes an entitlement to an app for a user. (entitlements.delete)
get()  : Google_Service_AndroidEnterprise_Entitlement
Retrieves details of an entitlement. (entitlements.get)
listEntitlements()  : Google_Service_AndroidEnterprise_EntitlementsListResponse
Lists all entitlements for the specified user. Only the ID is set.
update()  : Google_Service_AndroidEnterprise_Entitlement
Adds or updates an entitlement to an app for a user. (entitlements.update)
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()

Removes an entitlement to an app for a user. (entitlements.delete)

public delete(string $enterpriseId, string $userId, string $entitlementId[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$entitlementId : string

The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".

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

Optional parameters.

Return values
mixed

get()

Retrieves details of an entitlement. (entitlements.get)

public get(string $enterpriseId, string $userId, string $entitlementId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_Entitlement
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$entitlementId : string

The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".

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

Optional parameters.

Return values
Google_Service_AndroidEnterprise_Entitlement

listEntitlements()

Lists all entitlements for the specified user. Only the ID is set.

public listEntitlements(string $enterpriseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_EntitlementsListResponse

(entitlements.listEntitlements)

Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

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

Optional parameters.

Return values
Google_Service_AndroidEnterprise_EntitlementsListResponse

update()

Adds or updates an entitlement to an app for a user. (entitlements.update)

public update(string $enterpriseId, string $userId, string $entitlementId, Google_Service_AndroidEnterprise_Entitlement $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_Entitlement
Parameters
$enterpriseId : string

The ID of the enterprise.

$userId : string

The ID of the user.

$entitlementId : string

The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".

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

Optional parameters.

Tags
opt_param

bool install Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.

Return values
Google_Service_AndroidEnterprise_Entitlement

convertToArrayAndStripNulls()

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

Search results