Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_AndroidEnterprise_Enterprises_Resource Class Reference

The "enterprises" collection of methods. More...

Inheritance diagram for Google_Service_AndroidEnterprise_Enterprises_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($enterpriseId, $optParams=array())
 Deletes the binding between the MDM and enterprise.
 
 enroll ($token, Google_Service_AndroidEnterprise_Enterprise $postBody, $optParams=array())
 Enrolls an enterprise with the calling MDM.
 
 get ($enterpriseId, $optParams=array())
 Retrieves the name and domain of an enterprise.
 
 insert ($token, Google_Service_AndroidEnterprise_Enterprise $postBody, $optParams=array())
 Establishes the binding between the MDM and an enterprise.
 
 listEnterprises ($domain, $optParams=array())
 Looks up an enterprise by domain name.
 
 sendTestPushNotification ($enterpriseId, $optParams=array())
 Sends a test push notification to validate the MDM integration with the Google Cloud Pub/Sub service for this enterprise.
 
 setAccount ($enterpriseId, Google_Service_AndroidEnterprise_EnterpriseAccount $postBody, $optParams=array())
 Set the account that will be used to authenticate to the API as the enterprise.
 
 unenroll ($enterpriseId, $optParams=array())
 Unenrolls an enterprise from the calling MDM.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "enterprises" collection of methods.

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

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_Enterprises_Resource::delete ( $enterpriseId,
$optParams = array() )

Deletes the binding between the MDM and enterprise.

This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call. (enterprises.delete)

Parameters
string$enterpriseIdThe ID of the enterprise.
array$optParamsOptional parameters.

◆ enroll()

Google_Service_AndroidEnterprise_Enterprises_Resource::enroll ( $token,
Google_Service_AndroidEnterprise_Enterprise $postBody,
$optParams = array() )

Enrolls an enterprise with the calling MDM.

(enterprises.enroll)

Parameters
string$tokenThe token provided by the enterprise to register the MDM.
Google_Enterprise$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_Enterprise

◆ get()

Google_Service_AndroidEnterprise_Enterprises_Resource::get ( $enterpriseId,
$optParams = array() )

Retrieves the name and domain of an enterprise.

(enterprises.get)

Parameters
string$enterpriseIdThe ID of the enterprise.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_Enterprise

◆ insert()

Google_Service_AndroidEnterprise_Enterprises_Resource::insert ( $token,
Google_Service_AndroidEnterprise_Enterprise $postBody,
$optParams = array() )

Establishes the binding between the MDM and an enterprise.

This is now deprecated; use enroll instead. (enterprises.insert)

Parameters
string$tokenThe token provided by the enterprise to register the MDM.
Google_Enterprise$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_Enterprise

◆ listEnterprises()

Google_Service_AndroidEnterprise_Enterprises_Resource::listEnterprises ( $domain,
$optParams = array() )

Looks up an enterprise by domain name.

(enterprises.listEnterprises)

Parameters
string$domainThe exact primary domain name of the enterprise to look up.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_EnterprisesListResponse

◆ sendTestPushNotification()

Google_Service_AndroidEnterprise_Enterprises_Resource::sendTestPushNotification ( $enterpriseId,
$optParams = array() )

Sends a test push notification to validate the MDM integration with the Google Cloud Pub/Sub service for this enterprise.

(enterprises.sendTestPushNotification)

Parameters
string$enterpriseIdThe ID of the enterprise.
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_EnterprisesSendTestPushNotificationResponse

◆ setAccount()

Google_Service_AndroidEnterprise_Enterprises_Resource::setAccount ( $enterpriseId,
Google_Service_AndroidEnterprise_EnterpriseAccount $postBody,
$optParams = array() )

Set the account that will be used to authenticate to the API as the enterprise.

(enterprises.setAccount)

Parameters
string$enterpriseIdThe ID of the enterprise.
Google_EnterpriseAccount$postBody
array$optParamsOptional parameters.
Return values
Google_Service_AndroidEnterprise_EnterpriseAccount

◆ unenroll()

Google_Service_AndroidEnterprise_Enterprises_Resource::unenroll ( $enterpriseId,
$optParams = array() )

Unenrolls an enterprise from the calling MDM.

(enterprises.unenroll)

Parameters
string$enterpriseIdThe ID of the enterprise.
array$optParamsOptional parameters.

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