1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. Mobiledevices

Mobiledevices

class Mobiledevices extends Resource (View source)

The "mobiledevices" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $mobiledevices = $adminService->mobiledevices;

Methods

action(string $customerId, string $resourceId, MobileDeviceAction $postBody, array $optParams = [])

Takes an action that affects a mobile device. For example, remotely wiping a device. (mobiledevices.action)

delete(string $customerId, string $resourceId, array $optParams = [])

Removes a mobile device. (mobiledevices.delete)

MobileDevice
get(string $customerId, string $resourceId, array $optParams = [])

Retrieves a mobile device's properties. (mobiledevices.get)

MobileDevices
listMobiledevices(string $customerId, array $optParams = [])

Retrieves a paginated list of all user-owned mobile devices for an account.

Details

at line 49
action(string $customerId, string $resourceId, MobileDeviceAction $postBody, array $optParams = [])

Takes an action that affects a mobile device. For example, remotely wiping a device. (mobiledevices.action)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
string $resourceId

The unique ID the API service uses to identify the mobile device.
MobileDeviceAction $postBody
array $optParams

Optional parameters.

Exceptions

Exception

at line 68
delete(string $customerId, string $resourceId, array $optParams = [])

Removes a mobile device. (mobiledevices.delete)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
string $resourceId

The unique ID the API service uses to identify the mobile device.
array $optParams

Optional parameters.

Exceptions

Exception

at line 91
MobileDevice get(string $customerId, string $resourceId, array $optParams = [])

Retrieves a mobile device's properties. (mobiledevices.get)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
string $resourceId

The unique ID the API service uses to identify the mobile device.
array $optParams

Optional parameters.

Return Value

MobileDevice

Exceptions

Exception

at line 127
MobileDevices listMobiledevices(string $customerId, array $optParams = [])

Retrieves a paginated list of all user-owned mobile devices for an account.

To retrieve a list that includes company-owned devices, use the Cloud Identity Devices API instead. This method times out after 60 minutes. For more information, see Troubleshoot error codes. (mobiledevices.listMobiledevices)

Parameters

string $customerId

The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
array $optParams

Optional parameters.

Return Value

MobileDevices

Exceptions

Exception