com.google.api.services.licensing

Class Licensing.LicenseAssignments

java.lang.Object

com.google.api.services.licensing.Licensing.LicenseAssignments

Enclosing class:

Licensing

public class Licensing.LicenseAssignments
extends Object

The "licenseAssignments" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Licensing.LicenseAssignments.Delete
class	Licensing.LicenseAssignments.Get
class	Licensing.LicenseAssignments.Insert
class	Licensing.LicenseAssignments.ListForProduct
class	Licensing.LicenseAssignments.ListForProductAndSku
class	Licensing.LicenseAssignments.Patch
class	Licensing.LicenseAssignments.Update

Constructor Summary

Constructors

Constructor and Description
LicenseAssignments()

Method Summary

Modifier and Type	Method and Description
Licensing.LicenseAssignments.Delete	delete(String productId, String skuId, String userId) Revoke a license.
Licensing.LicenseAssignments.Get	get(String productId, String skuId, String userId) Get a specific user's license by product SKU.
Licensing.LicenseAssignments.Insert	insert(String productId, String skuId, LicenseAssignmentInsert content) Assign a license.
Licensing.LicenseAssignments.ListForProduct	listForProduct(String productId, String customerId) List all users assigned licenses for a specific product SKU.
Licensing.LicenseAssignments.ListForProductAndSku	listForProductAndSku(String productId, String skuId, String customerId) List all users assigned licenses for a specific product SKU.
Licensing.LicenseAssignments.Patch	patch(String productId, String skuId, String userId, LicenseAssignment content) Reassign a user's product SKU with a different SKU in the same product.
Licensing.LicenseAssignments.Update	update(String productId, String skuId, String userId, LicenseAssignment content) Reassign a user's product SKU with a different SKU in the same product.

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseAssignments

public LicenseAssignments()

Method Detail

delete

public Licensing.LicenseAssignments.Delete delete(String productId,
                                                  String skuId,
                                                  String userId)
                                           throws IOException

Revoke a license. Create a request for the method "licenseAssignments.delete". This request holds the parameters needed by the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

skuId - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.

userId - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.

Returns:

the request

Throws:

IOException

get

public Licensing.LicenseAssignments.Get get(String productId,
                                            String skuId,
                                            String userId)
                                     throws IOException

Get a specific user's license by product SKU. Create a request for the method "licenseAssignments.get". This request holds the parameters needed by the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

skuId - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.

userId - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.

Returns:

the request

Throws:

IOException

insert

public Licensing.LicenseAssignments.Insert insert(String productId,
                                                  String skuId,
                                                  LicenseAssignmentInsert content)
                                           throws IOException

Assign a license. Create a request for the method "licenseAssignments.insert". This request holds the parameters needed by the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

skuId - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.

content - the LicenseAssignmentInsert

Returns:

the request

Throws:

IOException

listForProduct

public Licensing.LicenseAssignments.ListForProduct listForProduct(String productId,
                                                                  String customerId)
                                                           throws IOException

List all users assigned licenses for a specific product SKU. Create a request for the method "licenseAssignments.listForProduct". This request holds the parameters needed by the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

customerId - The customer's unique ID as defined in the Admin console, such as `C00000000`. If the customer is suspended, the server returns an error.

Returns:

the request

Throws:

IOException

listForProductAndSku

public Licensing.LicenseAssignments.ListForProductAndSku listForProductAndSku(String productId,
                                                                              String skuId,
                                                                              String customerId)
                                                                       throws IOException

List all users assigned licenses for a specific product SKU. Create a request for the method "licenseAssignments.listForProductAndSku". This request holds the parameters needed by the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

skuId - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.

customerId - The customer's unique ID as defined in the Admin console, such as `C00000000`. If the customer is suspended, the server returns an error.

Returns:

the request

Throws:

IOException

patch

public Licensing.LicenseAssignments.Patch patch(String productId,
                                                String skuId,
                                                String userId,
                                                LicenseAssignment content)
                                         throws IOException

Reassign a user's product SKU with a different SKU in the same product. This method supports patch semantics. Create a request for the method "licenseAssignments.patch". This request holds the parameters needed by the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

skuId - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.

userId - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.

content - the LicenseAssignment

Returns:

the request

Throws:

IOException

update

public Licensing.LicenseAssignments.Update update(String productId,
                                                  String skuId,
                                                  String userId,
                                                  LicenseAssignment content)
                                           throws IOException

Reassign a user's product SKU with a different SKU in the same product. Create a request for the method "licenseAssignments.update". This request holds the parameters needed by the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

skuId - A product SKU's unique identifier. For more information about available SKUs in this version of the API, see Products and SKUs.

userId - The user's current primary email address. If the user's email address changes, use the new email address in your API requests. Since a `userId` is subject to change, do not use a `userId` value as a key for persistent data. This key could break if the current user's email address changes. If the `userId` is suspended, the license status changes.

content - the LicenseAssignment

Returns:

the request

Throws:

IOException