com.google.api.services.androidenterprise.model

Class Entitlement

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.androidenterprise.model.Entitlement

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Entitlement
extends com.google.api.client.json.GenericJson

The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device. The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created. If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted. If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement. Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Play EMM API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Entitlement()

Method Summary

Modifier and Type	Method and Description
Entitlement	clone()
String	getKind() Identifies what kind of resource this is.
String	getProductId() The ID of the product that the entitlement is for.
String	getReason() The reason for the entitlement.
Entitlement	set(String fieldName, Object value)
Entitlement	setKind(String kind) Identifies what kind of resource this is.
Entitlement	setProductId(String productId) The ID of the product that the entitlement is for.
Entitlement	setReason(String reason) The reason for the entitlement.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Entitlement

public Entitlement()

Method Detail

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".

Returns:

value or null for none

setKind

public Entitlement setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".

Parameters:

kind - kind or null for none

getProductId

public String getProductId()

The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".

Returns:

value or null for none

setProductId

public Entitlement setProductId(String productId)

The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".

Parameters:

productId - productId or null for none

getReason

public String getReason()

The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.

Returns:

value or null for none

setReason

public Entitlement setReason(String reason)

The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.

Parameters:

reason - reason or null for none

set

public Entitlement set(String fieldName,
                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Entitlement clone()

Overrides:

clone in class com.google.api.client.json.GenericJson