IEntitlementCollection Interface

Package:
com.microsoft.store.partnercenter.entitlements
Maven Artifact:
com.microsoft.store:partnercenter:1.15.3

Implements

IPartnerComponentString IEntireEntityCollectionRetrievalOperations<Entitlement,ResourceCollection<Entitlement>>

public interface IEntitlementCollection extends IPartnerComponentString, IEntireEntityCollectionRetrievalOperations<Entitlement,ResourceCollection<Entitlement>>

Represents the operations that can be performed on entitlements associated to the customer based on the logged in partner.

Method Summary

Modifier and Type Method and Description
abstract IEntireEntityCollectionRetrievalOperations<Entitlement,ResourceCollection<Entitlement>> byEntitlementType(String entitlementType)

Retrieves the operations that can be applied on entitlements with a given entitlement type.
abstract ResourceCollection<Entitlement> get(Boolean showExpiry)

Gets the entitlements for a customer.

Method Details

byEntitlementType

public abstract IEntireEntityCollectionRetrievalOperations> byEntitlementType(String entitlementType)

Retrieves the operations that can be applied on entitlements with a given entitlement type.

Parameters:

entitlementType - The type of entitlement.

Returns:

The entitlement collection operations by entitlement type.

get

public abstract ResourceCollection get(Boolean showExpiry)

Gets the entitlements for a customer.

Parameters:

showExpiry - A flag to indicate if the expiry date is required to be returned along with the entitlement (if applicable).

Returns:

The collection of entitlements for the customer.

Applies to