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

Class AmazonPlaybackEvent.Builder

java.lang.Object

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

Enclosing class:

AmazonPlaybackEvent

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

Builder class for object instantiation.

Since:

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

Method Summary

Modifier and Type	Method and Description
AmazonPlaybackEvent	buildActiveEvent() Converts the builder to an instance of an actively occurring event.
AmazonPlaybackEvent	buildOffDeviceEvent() Converts the builder to an instance of an off device playback event.
AmazonPlaybackEvent.Builder	contentId(AmazonContentId contentId) Sets the ID of the content being played.
AmazonPlaybackEvent.Builder	creditsPositionMs(long creditsPositionMs) Sets the position of the credits in the content, offset from 0.
AmazonPlaybackEvent.Builder	durationMs(long durationMs) Sets the duration of the content.
AmazonPlaybackEvent.Builder	eventTimestampMs(long eventTimestampMs) Sets the timestamp of when the playback event occurred.
AmazonPlaybackEvent.Builder	liveStationId(AmazonContentId liveStationId) Sets the ID of the linear station the content is playing on.
AmazonPlaybackEvent.Builder	playbackPositionMs(long playbackPositionMs) Sets the customer's current position in playback, offset from 0.
AmazonPlaybackEvent.Builder	profileId(AmazonProfileId profileId) Sets the associated profileId of the user who is watching the content.
AmazonPlaybackEvent.Builder	state(int state) Sets the customer's current viewing state of the content.

Methods inherited from class java.lang.Object

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

Method Detail

contentId

public AmazonPlaybackEvent.Builder contentId(AmazonContentId contentId)

Sets the ID of the content being played. This field is always required.

Parameters:

contentId - ID object.

Returns:

Builder object.

Since:

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

liveStationId

public AmazonPlaybackEvent.Builder liveStationId(AmazonContentId liveStationId)

Sets the ID of the linear station the content is playing on. This field is required only if the content is being played as part of a Live TV linear channel.

Parameters:

liveStationId - ID object.

Returns:

Builder object.

Since:

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

durationMs

public AmazonPlaybackEvent.Builder durationMs(long durationMs)

Sets the duration of the content.

Parameters:

durationMs - duration of the content in milliseconds.

Returns:

Builder object.

Since:

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

playbackPositionMs

public AmazonPlaybackEvent.Builder playbackPositionMs(long playbackPositionMs)

Sets the customer's current position in playback, offset from 0. This field is always required.

Parameters:

playbackPositionMs - current position in milliseconds.

Returns:

Builder object.

Since:

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

creditsPositionMs

public AmazonPlaybackEvent.Builder creditsPositionMs(long creditsPositionMs)

Sets the position of the credits in the content, offset from 0. Used for determining viewing completeness.

Parameters:

creditsPositionMs - credits position in milliseconds.

Returns:

Builder object.

Since:

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

eventTimestampMs

public AmazonPlaybackEvent.Builder eventTimestampMs(long eventTimestampMs)

Sets the timestamp of when the playback event occurred. This is required for playback events which did not occur on the same device.

Parameters:

eventTimestampMs - timestamp represented in millisecond format.

Returns:

Builder object.

Since:

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

state

public AmazonPlaybackEvent.Builder state(int state)

Sets the customer's current viewing state of the content. See AmazonPlaybackState for possible options. This field is always required.

Parameters:

state - current playback state of the content. See AmazonPlaybackState.

Returns:

Builder object.

Since:

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

profileId

public AmazonPlaybackEvent.Builder profileId(AmazonProfileId profileId)

Sets the associated profileId of the user who is watching the content.

Parameters:

profileId - An obfuscated profile ID.

Returns:

Builder object.

Since:

{public com.amazon.tv.developer.sdk.personalization.model.AmazonPlaybackEvent.Builder profileId(com.amazon.tv.developer.sdk.personalization.model.AmazonProfileId);}

buildActiveEvent

public AmazonPlaybackEvent buildActiveEvent()
                                     throws java.lang.IllegalArgumentException

Converts the builder to an instance of an actively occurring event. Use this for playback events occurring on device.

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.AmazonPlaybackEvent buildActiveEvent() throws java.lang.IllegalArgumentException;}

buildOffDeviceEvent

public AmazonPlaybackEvent buildOffDeviceEvent()

Converts the builder to an instance of an off device playback event. Use this for events occurring on other devices.

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.AmazonPlaybackEvent buildOffDeviceEvent();}