#include <group_license.h>

Inheritance diagram for google_androidenterprise_api::GroupLicense:

Public Member Functions
	GroupLicense (const Json::Value &storage)

	GroupLicense (Json::Value *storage)

virtual	~GroupLicense ()

const StringPiece	GetTypeName () const

bool	has_acquisition_kind () const

void	clear_acquisition_kind ()

const StringPiece	get_acquisition_kind () const

void	set_acquisition_kind (const StringPiece &value)

bool	has_approval () const

void	clear_approval ()

const StringPiece	get_approval () const

void	set_approval (const StringPiece &value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_num_provisioned () const

void	clear_num_provisioned ()

int32	get_num_provisioned () const

void	set_num_provisioned (int32 value)

bool	has_num_purchased () const

void	clear_num_purchased ()

int32	get_num_purchased () const

void	set_num_purchased (int32 value)

bool	has_permissions () const

void	clear_permissions ()

const StringPiece	get_permissions () const

void	set_permissions (const StringPiece &value)

bool	has_product_id () const

void	clear_product_id ()

const StringPiece	get_product_id () const

void	set_product_id (const StringPiece &value)

Static Public Member Functions
static GroupLicense *	New ()

Detailed Description

Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time.

Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product.

Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.

Constructor & Destructor Documentation

◆ GroupLicense() [1/2]

google_androidenterprise_api::GroupLicense::GroupLicense ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ GroupLicense() [2/2]

google_androidenterprise_api::GroupLicense::GroupLicense ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~GroupLicense()

google_androidenterprise_api::GroupLicense::~GroupLicense ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_acquisition_kind()

void google_androidenterprise_api::GroupLicense::clear_acquisition_kind ( )

inline

Clears the 'acquisitionKind' attribute.

◆ clear_approval()

void google_androidenterprise_api::GroupLicense::clear_approval ( )

inline

Clears the 'approval' attribute.

◆ clear_kind()

void google_androidenterprise_api::GroupLicense::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_num_provisioned()

void google_androidenterprise_api::GroupLicense::clear_num_provisioned ( )

inline

Clears the 'numProvisioned' attribute.

◆ clear_num_purchased()

void google_androidenterprise_api::GroupLicense::clear_num_purchased ( )

inline

Clears the 'numPurchased' attribute.

◆ clear_permissions()

void google_androidenterprise_api::GroupLicense::clear_permissions ( )

inline

Clears the 'permissions' attribute.

◆ clear_product_id()

void google_androidenterprise_api::GroupLicense::clear_product_id ( )

inline

Clears the 'productId' attribute.

◆ get_acquisition_kind()

const StringPiece google_androidenterprise_api::GroupLicense::get_acquisition_kind ( ) const

inline

Get the value of the 'acquisitionKind' attribute.

◆ get_approval()

const StringPiece google_androidenterprise_api::GroupLicense::get_approval ( ) const

inline

Get the value of the 'approval' attribute.

◆ get_kind()

const StringPiece google_androidenterprise_api::GroupLicense::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_num_provisioned()

int32 google_androidenterprise_api::GroupLicense::get_num_provisioned ( ) const

inline

Get the value of the 'numProvisioned' attribute.

◆ get_num_purchased()

int32 google_androidenterprise_api::GroupLicense::get_num_purchased ( ) const

inline

Get the value of the 'numPurchased' attribute.

◆ get_permissions()

const StringPiece google_androidenterprise_api::GroupLicense::get_permissions ( ) const

inline

Get the value of the 'permissions' attribute.

◆ get_product_id()

const StringPiece google_androidenterprise_api::GroupLicense::get_product_id ( ) const

inline

Get the value of the 'productId' attribute.

◆ GetTypeName()

const StringPiece google_androidenterprise_api::GroupLicense::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_androidenterprise_api::GroupLicense

◆ has_acquisition_kind()

bool google_androidenterprise_api::GroupLicense::has_acquisition_kind ( ) const

inline

Determine if the 'acquisitionKind' attribute was set.

Returns: true if the 'acquisitionKind' attribute was set.

◆ has_approval()

bool google_androidenterprise_api::GroupLicense::has_approval ( ) const

inline

Determine if the 'approval' attribute was set.

Returns: true if the 'approval' attribute was set.

◆ has_kind()

bool google_androidenterprise_api::GroupLicense::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_num_provisioned()

bool google_androidenterprise_api::GroupLicense::has_num_provisioned ( ) const

inline

Determine if the 'numProvisioned' attribute was set.

Returns: true if the 'numProvisioned' attribute was set.

◆ has_num_purchased()

bool google_androidenterprise_api::GroupLicense::has_num_purchased ( ) const

inline

Determine if the 'numPurchased' attribute was set.

Returns: true if the 'numPurchased' attribute was set.

◆ has_permissions()

bool google_androidenterprise_api::GroupLicense::has_permissions ( ) const

inline

Determine if the 'permissions' attribute was set.

Returns: true if the 'permissions' attribute was set.

◆ has_product_id()

bool google_androidenterprise_api::GroupLicense::has_product_id ( ) const

inline

Determine if the 'productId' attribute was set.

Returns: true if the 'productId' attribute was set.

◆ New()

GroupLicense * google_androidenterprise_api::GroupLicense::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_acquisition_kind()

void google_androidenterprise_api::GroupLicense::set_acquisition_kind ( const StringPiece & value )

inline

Change the 'acquisitionKind' attribute.

How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products).

Parameters

[in] value The new value.

◆ set_approval()

void google_androidenterprise_api::GroupLicense::set_approval ( const StringPiece & value )

inline

Change the 'approval' attribute.

Whether the product to which this group license relates is currently approved by the enterprise. Products are approved when a group license is first created, but this approval may be revoked by an enterprise admin via Google Play. Unapproved products will not be visible to end users in collections, and new entitlements to them should not normally be created.

Parameters

[in] value The new value.

◆ set_kind()

void google_androidenterprise_api::GroupLicense::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Parameters

[in] value The new value.

◆ set_num_provisioned()

void google_androidenterprise_api::GroupLicense::set_num_provisioned ( int32 value )

inline

Change the 'numProvisioned' attribute.

The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.

Parameters

[in] value The new value.

◆ set_num_purchased()

void google_androidenterprise_api::GroupLicense::set_num_purchased ( int32 value )

inline

Change the 'numPurchased' attribute.

The number of purchased licenses (possibly in multiple purchases). If this field is omitted, then there is no limit on the number of licenses that can be provisioned (for example, if the acquisition kind is "free").

Parameters

[in] value The new value.

◆ set_permissions()

void google_androidenterprise_api::GroupLicense::set_permissions ( const StringPiece & value )

inline

Change the 'permissions' attribute.

The permission approval status of the product. This field is only set if the product is approved. Possible states are:

"currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.),
"needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved,
"allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review.

Parameters

[in] value The new value.

◆ set_product_id()

void google_androidenterprise_api::GroupLicense::set_product_id ( const StringPiece & value )

inline

Change the 'productId' attribute.

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

Parameters

[in] value The new value.

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

google/androidenterprise_api/group_license.h
google/androidenterprise_api/group_license.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GroupLicense() [1/2]

◆ GroupLicense() [2/2]

◆ ~GroupLicense()

Member Function Documentation

◆ clear_acquisition_kind()

◆ clear_approval()

◆ clear_kind()

◆ clear_num_provisioned()

◆ clear_num_purchased()

◆ clear_permissions()

◆ clear_product_id()

◆ get_acquisition_kind()

◆ get_approval()

◆ get_kind()

◆ get_num_provisioned()

◆ get_num_purchased()

◆ get_permissions()

◆ get_product_id()

◆ GetTypeName()

◆ has_acquisition_kind()

◆ has_approval()

◆ has_kind()

◆ has_num_provisioned()

◆ has_num_purchased()

◆ has_permissions()

◆ has_product_id()

◆ New()

◆ set_acquisition_kind()

◆ set_approval()

◆ set_kind()

◆ set_num_provisioned()

◆ set_num_purchased()

◆ set_permissions()

◆ set_product_id()