com.google.api.services.androidenterprise

Class AndroidEnterprise.Enterprises

java.lang.Object

com.google.api.services.androidenterprise.AndroidEnterprise.Enterprises

Enclosing class:

AndroidEnterprise

public class AndroidEnterprise.Enterprises
extends java.lang.Object

The "enterprises" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AndroidEnterprise.Enterprises.AcknowledgeNotificationSet
class	AndroidEnterprise.Enterprises.CompleteSignup
class	AndroidEnterprise.Enterprises.CreateWebToken
class	AndroidEnterprise.Enterprises.Enroll
class	AndroidEnterprise.Enterprises.GenerateSignupUrl
class	AndroidEnterprise.Enterprises.Get
class	AndroidEnterprise.Enterprises.GetServiceAccount
class	AndroidEnterprise.Enterprises.GetStoreLayout
class	AndroidEnterprise.Enterprises.List
class	AndroidEnterprise.Enterprises.PullNotificationSet
class	AndroidEnterprise.Enterprises.SendTestPushNotification
class	AndroidEnterprise.Enterprises.SetAccount
class	AndroidEnterprise.Enterprises.SetStoreLayout
class	AndroidEnterprise.Enterprises.Unenroll

Constructor Summary

Constructors

Constructor and Description
Enterprises()

Method Summary

Modifier and Type	Method and Description
AndroidEnterprise.Enterprises.AcknowledgeNotificationSet	acknowledgeNotificationSet() Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
AndroidEnterprise.Enterprises.CompleteSignup	completeSignup() Completes the signup flow, by specifying the Completion token and Enterprise token.
AndroidEnterprise.Enterprises.CreateWebToken	createWebToken(java.lang.String enterpriseId, AdministratorWebTokenSpec content) Returns a unique token to access an embeddable UI.
AndroidEnterprise.Enterprises.Enroll	enroll(java.lang.String token, Enterprise content) Enrolls an enterprise with the calling EMM.
AndroidEnterprise.Enterprises.GenerateSignupUrl	generateSignupUrl() Generates a sign-up URL.
AndroidEnterprise.Enterprises.Get	get(java.lang.String enterpriseId) Retrieves the name and domain of an enterprise.
AndroidEnterprise.Enterprises.GetServiceAccount	getServiceAccount(java.lang.String enterpriseId) Returns a service account and credentials.
AndroidEnterprise.Enterprises.GetStoreLayout	getStoreLayout(java.lang.String enterpriseId) Returns the store layout for the enterprise.
AndroidEnterprise.Enterprises.List	list(java.lang.String domain) Looks up an enterprise by domain name.
AndroidEnterprise.Enterprises.PullNotificationSet	pullNotificationSet() Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request.
AndroidEnterprise.Enterprises.SendTestPushNotification	sendTestPushNotification(java.lang.String enterpriseId) Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
AndroidEnterprise.Enterprises.SetAccount	setAccount(java.lang.String enterpriseId, EnterpriseAccount content) Sets the account that will be used to authenticate to the API as the enterprise.
AndroidEnterprise.Enterprises.SetStoreLayout	setStoreLayout(java.lang.String enterpriseId, StoreLayout content) Sets the store layout for the enterprise.
AndroidEnterprise.Enterprises.Unenroll	unenroll(java.lang.String enterpriseId) Unenrolls an enterprise from the calling EMM.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Enterprises

public Enterprises()

Method Detail

acknowledgeNotificationSet

public AndroidEnterprise.Enterprises.AcknowledgeNotificationSet acknowledgeNotificationSet()
                                                                                    throws java.io.IOException

Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications. Create a request for the method "enterprises.acknowledgeNotificationSet". 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.

Returns:

the request

Throws:

java.io.IOException

completeSignup

public AndroidEnterprise.Enterprises.CompleteSignup completeSignup()
                                                            throws java.io.IOException

Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token. Create a request for the method "enterprises.completeSignup". 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.

Returns:

the request

Throws:

java.io.IOException

createWebToken

public AndroidEnterprise.Enterprises.CreateWebToken createWebToken(java.lang.String enterpriseId,
                                                                   AdministratorWebTokenSpec content)
                                                            throws java.io.IOException

Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information. Create a request for the method "enterprises.createWebToken". 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.

content - the AdministratorWebTokenSpec

Returns:

the request

Throws:

java.io.IOException

enroll

public AndroidEnterprise.Enterprises.Enroll enroll(java.lang.String token,
                                                   Enterprise content)
                                            throws java.io.IOException

Enrolls an enterprise with the calling EMM. Create a request for the method "enterprises.enroll". 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:

token - The token provided by the enterprise to register the EMM.

content - the Enterprise

Returns:

the request

Throws:

java.io.IOException

generateSignupUrl

public AndroidEnterprise.Enterprises.GenerateSignupUrl generateSignupUrl()
                                                                  throws java.io.IOException

Generates a sign-up URL. Create a request for the method "enterprises.generateSignupUrl". 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.

Returns:

the request

Throws:

java.io.IOException

get

public AndroidEnterprise.Enterprises.Get get(java.lang.String enterpriseId)
                                      throws java.io.IOException

Retrieves the name and domain of an enterprise. Create a request for the method "enterprises.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.

Returns:

the request

Throws:

java.io.IOException

getServiceAccount

public AndroidEnterprise.Enterprises.GetServiceAccount getServiceAccount(java.lang.String enterpriseId)
                                                                  throws java.io.IOException

Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server- side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource. Create a request for the method "enterprises.getServiceAccount". 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.

Returns:

the request

Throws:

java.io.IOException

getStoreLayout

public AndroidEnterprise.Enterprises.GetStoreLayout getStoreLayout(java.lang.String enterpriseId)
                                                            throws java.io.IOException

Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage. Create a request for the method "enterprises.getStoreLayout". 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.

Returns:

the request

Throws:

java.io.IOException

list

public AndroidEnterprise.Enterprises.List list(java.lang.String domain)
                                        throws java.io.IOException

Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call. Create a request for the method "enterprises.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:

domain - The exact primary domain name of the enterprise to look up.

Returns:

the request

Throws:

java.io.IOException

pullNotificationSet

public AndroidEnterprise.Enterprises.PullNotificationSet pullNotificationSet()
                                                                      throws java.io.IOException

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available. Create a request for the method "enterprises.pullNotificationSet". 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.

Returns:

the request

Throws:

java.io.IOException

sendTestPushNotification

public AndroidEnterprise.Enterprises.SendTestPushNotification sendTestPushNotification(java.lang.String enterpriseId)
                                                                                throws java.io.IOException

Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise. Create a request for the method "enterprises.sendTestPushNotification". 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.

Returns:

the request

Throws:

java.io.IOException

setAccount

public AndroidEnterprise.Enterprises.SetAccount setAccount(java.lang.String enterpriseId,
                                                           EnterpriseAccount content)
                                                    throws java.io.IOException

Sets the account that will be used to authenticate to the API as the enterprise. Create a request for the method "enterprises.setAccount". 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.

content - the EnterpriseAccount

Returns:

the request

Throws:

java.io.IOException

setStoreLayout

public AndroidEnterprise.Enterprises.SetStoreLayout setStoreLayout(java.lang.String enterpriseId,
                                                                   StoreLayout content)
                                                            throws java.io.IOException

Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled. Create a request for the method "enterprises.setStoreLayout". 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.

content - the StoreLayout

Returns:

the request

Throws:

java.io.IOException

unenroll

public AndroidEnterprise.Enterprises.Unenroll unenroll(java.lang.String enterpriseId)
                                                throws java.io.IOException

Unenrolls an enterprise from the calling EMM. Create a request for the method "enterprises.unenroll". 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.

Returns:

the request

Throws:

java.io.IOException