Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support
Native
Skip to main content

Interface ISubscriptionEntitlementServer2

interface ISubscriptionEntitlementServer2
Extends com.amazon.apmf.IStandard Interface for Subscription Entitlement Server - v2

Methods

setSubscriptionEntitlementsHandlerForComponent()

void setSubscriptionEntitlementsHandlerForComponent(ISubscriptionEntitlementsHandlerAsync* subscriptionEntitlementsHandler, com.amazon.kepler.runtime.IComponentInstance* component)
Sets the handler for specific component that will provide subscription entitlement data in response to commands.

Parameters

subscriptionEntitlementsHandler
ISubscriptionEntitlementsHandlerAsync* — Required The handler for commands relating to subscription entitlement.
component
com.amazon.kepler.runtime.IComponentInstance* — Required The component instance for which the handler is being set. Example usage:

reportNewSubscription()

void reportNewSubscription(ISubscriptionEntitlementEntry* subscription)
Deprecated, please use [ISubscriptionEntitlementServer2#setSubscriptions] instead Reports that the customer has a new subscription inserted into their existing subscription list. Only for subscriptions inserted due to on-device customer action. Should be reported at time of insertion.

Parameters

subscription
ISubscriptionEntitlementEntry* — Required The new subscription. Example usage:

reportRemovedSubscription()

void reportRemovedSubscription(ISubscriptionEntitlementEntry* subscription)
Deprecated, please use [ISubscriptionEntitlementServer2#setSubscriptions] instead Reports that the customer no longer has a subscription in their existing subscription list. Only for subscriptions that are no longer valid or expire due to on-device action. Should be reported at time of removal.

Parameters

subscription
ISubscriptionEntitlementEntry* — Required The removed subscription. Example usage:

reportRefreshedSubscriptions()

void reportRefreshedSubscriptions()
Indicates that there have been changes to the subscription entitlement due to off-device actions and a new refreshed list of subscriptions should be fetched. Before using this API, setSubscriptionEntitlementsHandlerForComponent needs to be called.

setSubscriptions()

void setSubscriptions(ISubscriptionEntitlementEntry*[] subscriptions)
Sets subscriptions list, overwriting the previous subscriptions

Parameters

subscriptions
ISubscriptionEntitlementEntry*[] — Required The list of subscriptions
Last modified on October 29, 2026