com.amazon.tv.developer.sdk.personalization.model

Class AmazonContentEntitlement.Builder

java.lang.Object

com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement.Builder

Enclosing class:

AmazonContentEntitlement

public static class AmazonContentEntitlement.Builder
extends java.lang.Object

Builder class for object instantiation.

Since:

{public class com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement.Builder {}

Method Summary

Modifier and Type	Method and Description
AmazonContentEntitlement.Builder	acquisitionTimestampMs(long acquisitionTimestampMs) Sets the date the entitlement was acquired.
AmazonContentEntitlement	build() Converts the builder to an instance.
AmazonContentEntitlement.Builder	contentId(AmazonContentId contentId) Sets the ID of the content entitlement.
AmazonContentEntitlement.Builder	expirationTimestampMs(long expirationTimestampMs) Sets the date of expiration.
AmazonContentEntitlement.Builder	type(int type) Sets the type of entitlement e.g., purchase.

Methods inherited from class java.lang.Object

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

Method Detail

contentId

public AmazonContentEntitlement.Builder contentId(AmazonContentId contentId)

Sets the ID of the content entitlement. This field is always required.

Parameters:

contentId - ID object.

Returns:

Builder object.

Since:

{public com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement.Builder contentId(com.amazon.tv.developer.sdk.personalization.model.AmazonContentId);}

type

public AmazonContentEntitlement.Builder type(int type)

Sets the type of entitlement e.g., purchase. See AmazonEntitlementType for all accepted values. This field is always required.

Parameters:

type - Entitlement type. See AmazonEntitlementType.

Returns:

Builder object.

Since:

{public com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement.Builder type(int);}

expirationTimestampMs

public AmazonContentEntitlement.Builder expirationTimestampMs(long expirationTimestampMs)

Sets the date of expiration. Value of less than or equal to 0 implies no expiration. For complex expiry logic call AmazonEntitlementReceiver.removeContentEntitlements(java.util.List<com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement>) at time of expiration rather than relying on the timestamp.

Parameters:

expirationTimestampMs - Expiration date timestamp in milliseconds since epoch format.

Returns:

Builder object.

Since:

{public com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement.Builder expirationTimestampMs(long);}

acquisitionTimestampMs

public AmazonContentEntitlement.Builder acquisitionTimestampMs(long acquisitionTimestampMs)

Sets the date the entitlement was acquired.

Parameters:

acquisitionTimestampMs - Acquisition date timestamp in milliseconds since epoch format.

Returns:

Builder object.

Since:

{public com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement.Builder acquisitionTimestampMs(long);}

build

public AmazonContentEntitlement build()
                               throws java.lang.IllegalArgumentException

Converts the builder to an instance.

Returns:

The populated instance.

Throws:

java.lang.IllegalArgumentException - if data is missing required fields or fails basic data validation.

Since:

{public com.amazon.tv.developer.sdk.personalization.model.AmazonContentEntitlement build() throws java.lang.IllegalArgumentException;}