com.amazon.tv.developer.sdk.personalization

Class AmazonEntitlementReceiver

java.lang.Object

com.amazon.tv.developer.sdk.personalization.AmazonEntitlementReceiver

public class AmazonEntitlementReceiver
extends java.lang.Object

Receiver class used to share customer subscription and individual content entitlement updates. Use the getInstance(Context) method to access an instance.

Since:

{public class com.amazon.tv.developer.sdk.personalization.AmazonEntitlementReceiver {}

Method Summary

Modifier and Type	Method and Description
void	addContentEntitlement(AmazonContentEntitlement entitlement) Adds a single content entitlements (e.g., purchase, rental, etc.).
void	addContentEntitlements(java.util.List<AmazonContentEntitlement> entitlements) Adds a list of content entitlements (e.g., purchase, rental, etc.).
void	addSubscription(AmazonSubscriptionEntitlement subscription) Adds a single entitled subscription.
void	addSubscriptions(java.util.List<AmazonSubscriptionEntitlement> subscriptions) Adds a list of entitled subscriptions.
void	clearAllEntitlements() Clears all entitlement for the customer.
static AmazonEntitlementReceiver	getInstance(android.content.Context context) Returns an instance of the AmazonEntitlementReceiver to receive customer entitlement updates.
void	removeContentEntitlement(AmazonContentEntitlement entitlement) Removes a single content entitlement (e.g., purchase, rental, etc.).
void	removeContentEntitlements(java.util.List<AmazonContentEntitlement> entitlements) Removes a list of content entitlements (e.g., purchase, rental, etc.).
void	removeSubscription(AmazonSubscriptionEntitlement subscription) Removes a single subscription which is no longer entitled.
void	removeSubscriptions(java.util.List<AmazonSubscriptionEntitlement> subscriptions) Removes a list of subscriptions which are no longer entitled.
void	setContentEntitlements(int listStatus, java.util.List<AmazonContentEntitlement> entitlements) Sets the list of content entitlements (e.g., purchase, rental, etc.) with paging capability.
void	setContentEntitlements(java.util.List<AmazonContentEntitlement> entitlements) Sets the list of content entitlements (e.g., purchase, rental, etc.).
void	setSubscriptions(int listStatus, java.util.List<AmazonSubscriptionEntitlement> subscriptions) Sets the list of all entitled subscriptions with paging capability.
void	setSubscriptions(java.util.List<AmazonSubscriptionEntitlement> subscriptions) Sets the list of all entitled subscriptions.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static AmazonEntitlementReceiver getInstance(android.content.Context context)

Returns an instance of the AmazonEntitlementReceiver to receive customer entitlement updates.

Parameters:

context - The Android context object, used to bind to the receiver service.

Returns:

An AmazonEntitlementReceiver instance.

Since:

{public static synchronized com.amazon.tv.developer.sdk.personalization.AmazonEntitlementReceiver getInstance(android.content.Context);}

addContentEntitlements

public void addContentEntitlements(java.util.List<AmazonContentEntitlement> entitlements)

Adds a list of content entitlements (e.g., purchase, rental, etc.). This should only include entitlements not contained in the subscription.

Parameters:

entitlements - List of entitlements to be added.

Since:

{public void addContentEntitlements(java.util.List);}

addContentEntitlement

public void addContentEntitlement(AmazonContentEntitlement entitlement)

Adds a single content entitlements (e.g., purchase, rental, etc.).

Parameters:

entitlement - Entitlement to be added.

Since:

{public void addContentEntitlement(com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement);}

setContentEntitlements

public void setContentEntitlements(int listStatus,
                                   java.util.List<AmazonContentEntitlement> entitlements)

Sets the list of content entitlements (e.g., purchase, rental, etc.) with paging capability. This should only include entitlements not contained in the subscription. Note that this will erase any existing state of the active entitlements.

Parameters:

entitlements - Complete list of entitlements to be set.

listStatus - indicates if the list is complete or has more items remaining to support sending data in pages. See AmazonSetListStatus for more information and options.

Since:

{public void setContentEntitlements(int, java.util.List);}

setContentEntitlements

public void setContentEntitlements(java.util.List<AmazonContentEntitlement> entitlements)

Sets the list of content entitlements (e.g., purchase, rental, etc.). This should only include entitlements not contained in the subscription. Note that this will erase any existing state of the active entitlements. If you need to send data in pages use setContentEntitlements(int, List).

Parameters:

entitlements - Complete list of entitlements to be set.

Since:

{public void setContentEntitlements(java.util.List);}

removeContentEntitlements

public void removeContentEntitlements(java.util.List<AmazonContentEntitlement> entitlements)

Removes a list of content entitlements (e.g., purchase, rental, etc.). Entitlements can expire based upon a timestamp provided when adding or by invoking this method as needed. This is useful to handle complex expiry cases.

Parameters:

entitlements - List of entitlements to be removed.

Since:

{public void removeContentEntitlements(java.util.List);}

removeContentEntitlement

public void removeContentEntitlement(AmazonContentEntitlement entitlement)

Removes a single content entitlement (e.g., purchase, rental, etc.). Entitlements can expire based upon a timestamp provided when adding or by invoking this method as needed. This is useful to handle complex expiry cases.

Parameters:

entitlement - Entitlement to be removed.

Since:

{public void removeContentEntitlement(com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement);}

addSubscriptions

public void addSubscriptions(java.util.List<AmazonSubscriptionEntitlement> subscriptions)

Adds a list of entitled subscriptions.

Parameters:

subscriptions - List of subscriptions to be added.

Since:

{public void addSubscriptions(java.util.List);}

addSubscription

public void addSubscription(AmazonSubscriptionEntitlement subscription)

Adds a single entitled subscription.

Parameters:

subscription - Subscription to be added.

Since:

{public void addSubscription(com.amazon.tv.developer.sdk.personalization.model.AmazonSubscriptionEntitlement);}

setSubscriptions

public void setSubscriptions(int listStatus,
                             java.util.List<AmazonSubscriptionEntitlement> subscriptions)

Sets the list of all entitled subscriptions with paging capability.

Parameters:

listStatus - indicates if the list is complete or has more items remaining to support sending data in pages. See AmazonSetListStatus for more information and options.

subscriptions - Complete list of subscriptions the customer is entitled to.

Since:

{public void setSubscriptions(int, java.util.List);}

setSubscriptions

public void setSubscriptions(java.util.List<AmazonSubscriptionEntitlement> subscriptions)

Sets the list of all entitled subscriptions. If you need to pass data in chunks use setSubscriptions(int, List).

Parameters:

subscriptions - Complete list of subscriptions the customer is entitled to.

Since:

{public void setSubscriptions(java.util.List);}

removeSubscriptions

public void removeSubscriptions(java.util.List<AmazonSubscriptionEntitlement> subscriptions)

Removes a list of subscriptions which are no longer entitled.

Parameters:

subscriptions - List of subscriptions to be removed.

Since:

{public void removeSubscriptions(java.util.List);}

removeSubscription

public void removeSubscription(AmazonSubscriptionEntitlement subscription)

Removes a single subscription which is no longer entitled.

Parameters:

subscription - Subscription to be removed.

Since:

{public void removeSubscription(com.amazon.tv.developer.sdk.personalization.model.AmazonSubscriptionEntitlement);}

clearAllEntitlements

public void clearAllEntitlements()

Clears all entitlement for the customer. Useful for the sign out case.

Since:

{public void clearAllEntitlements();}