Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_AndroidEnterprise_Entitlements_Resource Class Reference

The "entitlements" collection of methods. More...

Inheritance diagram for Google_Service_AndroidEnterprise_Entitlements_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($enterpriseId, $userId, $entitlementId, $optParams=array())
 Removes an entitlement to an app for a user and uninstalls it.
 
 get ($enterpriseId, $userId, $entitlementId, $optParams=array())
 Retrieves details of an entitlement.
 
 listEntitlements ($enterpriseId, $userId, $optParams=array())
 List of all entitlements for the specified user.
 
 patch ($enterpriseId, $userId, $entitlementId, Google_Service_AndroidEnterprise_Entitlement $postBody, $optParams=array())
 Adds or updates an entitlement to an app for a user.
 
 update ($enterpriseId, $userId, $entitlementId, Google_Service_AndroidEnterprise_Entitlement $postBody, $optParams=array())
 Adds or updates an entitlement to an app for a user.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "entitlements" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_AndroidEnterprise_Entitlements_Resource::delete ( $enterpriseId,
$userId,
$entitlementId,
$optParams = array() )

Removes an entitlement to an app for a user and uninstalls it.

(entitlements.delete)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
string$entitlementIdThe ID of the entitlement, e.g. "app:com.google.android.gm".
array$optParamsOptional parameters.

◆ get()

Google_Service_AndroidEnterprise_Entitlements_Resource::get ( $enterpriseId,
$userId,
$entitlementId,
$optParams = array() )

Retrieves details of an entitlement.

(entitlements.get)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
string$entitlementIdThe ID of the entitlement, e.g. "app:com.google.android.gm".
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_Entitlement

◆ listEntitlements()

Google_Service_AndroidEnterprise_Entitlements_Resource::listEntitlements ( $enterpriseId,
$userId,
$optParams = array() )

List of all entitlements for the specified user.

Only the ID is set. (entitlements.listEntitlements)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_EntitlementsListResponse

◆ patch()

Google_Service_AndroidEnterprise_Entitlements_Resource::patch ( $enterpriseId,
$userId,
$entitlementId,
Google_Service_AndroidEnterprise_Entitlement $postBody,
$optParams = array() )

Adds or updates an entitlement to an app for a user.

This method supports patch semantics. (entitlements.patch)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
string$entitlementIdThe ID of the entitlement, e.g. "app:com.google.android.gm".
Google_Entitlement$postBody
array$optParamsOptional parameters.

@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

◆ update()

Google_Service_AndroidEnterprise_Entitlements_Resource::update ( $enterpriseId,
$userId,
$entitlementId,
Google_Service_AndroidEnterprise_Entitlement $postBody,
$optParams = array() )

Adds or updates an entitlement to an app for a user.

(entitlements.update)

Parameters
string$enterpriseIdThe ID of the enterprise.
string$userIdThe ID of the user.
string$entitlementIdThe ID of the entitlement, e.g. "app:com.google.android.gm".
Google_Entitlement$postBody
array$optParamsOptional parameters.

@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

The documentation for this class was generated from the following file: