com.amazon.ask.model.interfaces.alexa.presentation.apl

Class SendIndexListDataDirective

java.lang.Object

com.amazon.ask.model.Directive

com.amazon.ask.model.interfaces.alexa.presentation.apl.SendIndexListDataDirective

public final class SendIndexListDataDirective
extends Directive

Returned in response to a LoadIndexListData event, containing the requested items and metadata for further interaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SendIndexListDataDirective.Builder

Field Summary

Fields inherited from class com.amazon.ask.model.Directive

type

Method Summary

Modifier and Type	Method and Description
static SendIndexListDataDirective.Builder	builder()
boolean	equals(Object o)
String	getCorrelationToken() The correlation token supplied in the LoadTokenListData event.
List<Object>	getItems() Array of objects to be added to the device cache.
String	getListId() The identifier of the list whose items are contained in this response.
Integer	getListVersion() The new version of the list after loading the items supplied in this directive.
Integer	getMaximumExclusiveIndex() The last valid index of the skill-managed array plus one, i.e.
Integer	getMinimumInclusiveIndex() The index of the 1st item in the skill-managed array.
Integer	getStartIndex() Index of the first element in the items array.
int	hashCode()
String	toString()

Methods inherited from class com.amazon.ask.model.Directive

getType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static SendIndexListDataDirective.Builder builder()

getCorrelationToken

public String getCorrelationToken()

The correlation token supplied in the LoadTokenListData event. This parameter is mandatory if the skill is responding to a LoadIndexListData request, the skill response will be rejected if the expected correlationToken is not specified.

Returns:

correlationToken

getListId

public String getListId()

The identifier of the list whose items are contained in this response.

Returns:

listId

getListVersion

public Integer getListVersion()

The new version of the list after loading the items supplied in this directive. List versions increase sequentially, implicitly starting at 0 for the definition specified in the presentation's RenderDocument directive.

Returns:

listVersion

getStartIndex

public Integer getStartIndex()

Index of the first element in the items array.

Returns:

startIndex

getMinimumInclusiveIndex

public Integer getMinimumInclusiveIndex()

The index of the 1st item in the skill-managed array. When populated, this value replaces any value that was specified in a previous interaction. Continued absence of this property indicates that the minimum index is not yet known and further backwards scrolling is possible. If this is equal to the index of the 1st item returned then no further backwards scrolling is possible.

Returns:

minimumInclusiveIndex

getMaximumExclusiveIndex

public Integer getMaximumExclusiveIndex()

The last valid index of the skill-managed array plus one, i.e. exclusive value. When populated, this value replaces any value that was specified in a previous interaction. Continued absence of this property indicates that the maximum index is not yet known and further forwards scrolling is possible. If this is one more than the index of the last item returned then no further forwards scrolling is possible.

Returns:

maximumExclusiveIndex

getItems

public List<Object> getItems()

Array of objects to be added to the device cache.

Returns:

items

equals

public boolean equals(Object o)

Overrides:

equals in class Directive

hashCode

public int hashCode()

Overrides:

hashCode in class Directive

toString

public String toString()

Overrides:

toString in class Directive