target.apidocs.com.google.api.services.androidenterprise.AndroidEnterprise.Devices.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-androidenterprise Show documentation

There is a newer version: v1-rev20241113-2.0.0

Show newest version







AndroidEnterprise.Devices (Google Play EMM API v1-rev20210723-1.32.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.androidenterprise
Class AndroidEnterprise.Devices



java.lang.Object


com.google.api.services.androidenterprise.AndroidEnterprise.Devices







Enclosing class:
AndroidEnterprise




public class AndroidEnterprise.Devices
extends Object
The "devices" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
AndroidEnterprise.Devices.ForceReportUpload 


class 
AndroidEnterprise.Devices.Get 


class 
AndroidEnterprise.Devices.GetState 


class 
AndroidEnterprise.Devices.List 


class 
AndroidEnterprise.Devices.SetState 


class 
AndroidEnterprise.Devices.Update 









Constructor Summary

Constructors 

Constructor and Description


Devices() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AndroidEnterprise.Devices.ForceReportUpload
forceReportUpload(String enterpriseId,
                 String userId,
                 String deviceId)
Uploads a report containing any changes in app states on the device since the last report was
 generated.



AndroidEnterprise.Devices.Get
get(String enterpriseId,
   String userId,
   String deviceId)
Retrieves the details of a device.



AndroidEnterprise.Devices.GetState
getState(String enterpriseId,
        String userId,
        String deviceId)
Retrieves whether a device's access to Google services is enabled or disabled.



AndroidEnterprise.Devices.List
list(String enterpriseId,
    String userId)
Retrieves the IDs of all of a user's devices.



AndroidEnterprise.Devices.SetState
setState(String enterpriseId,
        String userId,
        String deviceId,
        DeviceState content)
Sets whether a device's access to Google services is enabled or disabled.



AndroidEnterprise.Devices.Update
update(String enterpriseId,
      String userId,
      String deviceId,
      Device content)
Updates the device policy.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Devices
public Devices()









Method Detail





forceReportUpload
public AndroidEnterprise.Devices.ForceReportUpload forceReportUpload(String enterpriseId,
                                                                     String userId,
                                                                     String deviceId)
                                                              throws IOException
Uploads a report containing any changes in app states on the device since the last report was
 generated. You can call this method up to 3 times every 24 hours for a given device. If you
 exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.

 Create a request for the method "devices.forceReportUpload".

 This request holds the parameters needed by the androidenterprise server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
enterpriseId - The ID of the enterprise.
userId - The ID of the user.
deviceId - The ID of the device.
Returns:
the request
Throws:
IOException








get
public AndroidEnterprise.Devices.Get get(String enterpriseId,
                                         String userId,
                                         String deviceId)
                                  throws IOException
Retrieves the details of a device.

 Create a request for the method "devices.get".

 This request holds the parameters needed by the androidenterprise server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
enterpriseId - The ID of the enterprise.
userId - The ID of the user.
deviceId - The ID of the device.
Returns:
the request
Throws:
IOException








getState
public AndroidEnterprise.Devices.GetState getState(String enterpriseId,
                                                   String userId,
                                                   String deviceId)
                                            throws IOException
Retrieves whether a device's access to Google services is enabled or disabled. The device state
 takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin
 Console. Otherwise, the device state is ignored and all devices are allowed access to Google
 services. This is only supported for Google-managed users.

 Create a request for the method "devices.getState".

 This request holds the parameters needed by the androidenterprise server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
enterpriseId - The ID of the enterprise.
userId - The ID of the user.
deviceId - The ID of the device.
Returns:
the request
Throws:
IOException








list
public AndroidEnterprise.Devices.List list(String enterpriseId,
                                           String userId)
                                    throws IOException
Retrieves the IDs of all of a user's devices.

 Create a request for the method "devices.list".

 This request holds the parameters needed by the androidenterprise server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
enterpriseId - The ID of the enterprise.
userId - The ID of the user.
Returns:
the request
Throws:
IOException








setState
public AndroidEnterprise.Devices.SetState setState(String enterpriseId,
                                                   String userId,
                                                   String deviceId,
                                                   DeviceState content)
                                            throws IOException
Sets whether a device's access to Google services is enabled or disabled. The device state takes
 effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console.
 Otherwise, the device state is ignored and all devices are allowed access to Google services.
 This is only supported for Google-managed users.

 Create a request for the method "devices.setState".

 This request holds the parameters needed by the androidenterprise server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
enterpriseId - The ID of the enterprise.
userId - The ID of the user.
deviceId - The ID of the device.
content - the DeviceState
Returns:
the request
Throws:
IOException








update
public AndroidEnterprise.Devices.Update update(String enterpriseId,
                                               String userId,
                                               String deviceId,
                                               Device content)
                                        throws IOException
Updates the device policy. To ensure the policy is properly enforced, you need to prevent
 unmanaged accounts from accessing Google Play by setting the allowed_accounts in the managed
 configuration for the Google Play package. See restrict accounts in Google Play. When
 provisioning a new device, you should set the device policy using this method before adding the
 managed Google Play Account to the device, otherwise the policy will not be applied for a short
 period of time after adding the account to the device.

 Create a request for the method "devices.update".

 This request holds the parameters needed by the androidenterprise server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
enterpriseId - The ID of the enterprise.
userId - The ID of the user.
deviceId - The ID of the device.
content - the Device
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2021 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`AndroidEnterprise.Devices.ForceReportUpload`
`class`	`AndroidEnterprise.Devices.Get`
`class`	`AndroidEnterprise.Devices.GetState`
`class`	`AndroidEnterprise.Devices.List`
`class`	`AndroidEnterprise.Devices.SetState`
`class`	`AndroidEnterprise.Devices.Update`

Modifier and Type	Method and Description
`AndroidEnterprise.Devices.ForceReportUpload`	`forceReportUpload(String enterpriseId, String userId, String deviceId)` Uploads a report containing any changes in app states on the device since the last report was generated.
`AndroidEnterprise.Devices.Get`	`get(String enterpriseId, String userId, String deviceId)` Retrieves the details of a device.
`AndroidEnterprise.Devices.GetState`	`getState(String enterpriseId, String userId, String deviceId)` Retrieves whether a device's access to Google services is enabled or disabled.
`AndroidEnterprise.Devices.List`	`list(String enterpriseId, String userId)` Retrieves the IDs of all of a user's devices.
`AndroidEnterprise.Devices.SetState`	`setState(String enterpriseId, String userId, String deviceId, DeviceState content)` Sets whether a device's access to Google services is enabled or disabled.
`AndroidEnterprise.Devices.Update`	`update(String enterpriseId, String userId, String deviceId, Device content)` Updates the device policy.