Methods
reportNewContentEntitlement()
reportNewContentEntitlement(entitlement): void
Reports that the customer has a new individual content entitlement inserted into their existing content entitlement list.
Only for entitlement not already contained in subscriptions.
Only for entitlement inserted due to on-device customer action. Should be reported at time of insertion.
Parameters
entitlement
IContentEntitlement
The new enitlement.
Returns
void
Example
reportNewContentInteraction()
reportNewContentInteraction(contentInteraction): void
Reports a customer has interacted with content (Liked, disliked, watched trailer, etc..)
Parameters
contentInteraction
IContentInteraction
The content interaction that has occurred.
Returns
void
Example
reportNewCustomerListEntry()
reportNewCustomerListEntry(listType, entry): void
Reports that the customer has inserted a new entry into a customer managed list.
Only for entries inserted on-device due to customer action. Should be reported at time of insertion.
Parameters
listType
WATCHLIST
The type of customer list the entry was inserted into.
entry
ICustomerListEntry
The entry added the customer list.
Returns
void
Example
reportNewPlaybackEvent()
reportNewPlaybackEvent(playbackEvent): void
Reports updates about the customers playback behavior while they are actively in playback.
Parameters
playbackEvent
IPlaybackEvent
The playback event that just occurred on the device.
Returns
void
Example
reportRefreshedContentEntitlements()
reportRefreshedContentEntitlements():void
Indicates that there have been changes to the individual content entitlement due to off-device actions
and a new refreshed list of content entitlement should be fetched.
Before using this API, setContentEntitlementsHandlerForComponent needs to be called.
Returns
void
reportRefreshedCustomerList()
reportRefreshedCustomerList(listType): void
Indicates that there have been changes to a customer managed list due to off-device actions
and a new refreshed version of the customer managed list should be fetched.
Before using this API, setCustomerListEntriesHandlerForComponent needs to be called.
Parameters
listType
WATCHLIST
The type of customer list that has changed.
Returns
void
reportRefreshedPlaybackEvents()
reportRefreshedPlaybackEvents():void
Indicates that there are new updates about a customers playback behavior that occurred off-device that can be fetched.
Before using this API, setPlaybackEventsHandlerForComponent needs to be called.
Returns
void
reportRemovedContentEntitlement()
reportRemovedContentEntitlement(entitlement): void
Reports that the customer no longer has a individual content entitlement in their existing content entitlement list.
Only for entitlement not contained in subscriptions.
Only for entitlement that is no longer valid or expires due to due to on-device action. Should be reported at time of removal.
Parameters
entitlement
IContentEntitlement
The removed enitlement.
Returns
void
Example
reportRemovedCustomerListEntry()
reportRemovedCustomerListEntry(listType, entry): void
Reports that the customer has removed an entry from a customer managed list.
Only for entries removed from on-device due to customer action. Should be reported at time of removal.
Parameters
listType
WATCHLIST
The type of customer list the entry was removed from.
entry
ICustomerListEntry
The entry removed from the customer list.
Returns
void
Example
setContentEntitlementsHandler()
setContentEntitlementsHandler(contentEntitlementsHandler): void
Parameters
contentEntitlementsHandler
IContentEntitlementsHandler
Returns
void
Deprecated
This method is deprecated, please use setContentEntitlementsHandlerForComponent instead.setContentEntitlementsHandlerForComponent()
setContentEntitlementsHandlerForComponent(contentEntitlementsHandler, component): void
Sets the handler for specific component that will provide content entitlement data in response to commands.
Parameters
contentEntitlementsHandler
IContentEntitlementsHandler
The handler for commands relating to content entitlement.
component
IComponentInstance
The component instance for which the handler is being set.
Returns
void
Example
setCustomerListEntriesHandler()
setCustomerListEntriesHandler(customerListEntriesHandler): void
Parameters
customerListEntriesHandler
ICustomerListEntriesHandler
Returns
void
Deprecated
This method is deprecated, please use setCustomerListEntriesHandlerForComponent instead.setCustomerListEntriesHandlerForComponent()
setCustomerListEntriesHandlerForComponent(customerListEntriesHandler, component): void
Sets the handler for specific component that will provide customer list entry data in response to commands.
Parameters
customerListEntriesHandler
ICustomerListEntriesHandler
The handler for commands relating to customer lists.
component
IComponentInstance
The component instance for which the handler is being set.
Returns
void
Example
setPlaybackEventsHandler()
setPlaybackEventsHandler(playbackEventsHandler): void
Parameters
playbackEventsHandler
IPlaybackEventsHandler
Returns
void
Deprecated
This method is deprecated, please use setPlaybackEventsHandlerForComponent instead.setPlaybackEventsHandlerForComponent()
setPlaybackEventsHandlerForComponent(playbackEventsHandler, component): void
Sets the handler for specific component that will provide playback event data in response to commands.
Parameters
playbackEventsHandler
IPlaybackEventsHandler
The handler for commands relating to playback events.
component
IComponentInstance
The component instance for which the handler is being set.
Returns
void

