com.amazon.ask.model.services.gameEngine

Class Event

java.lang.Object

com.amazon.ask.model.services.gameEngine.Event

public final class Event
extends Object

The events object is where you define the conditions that must be met for your skill to be notified of Echo Button input. You must define at least one event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Builder

Method Summary

Modifier and Type	Method and Description
static Event.Builder	builder()
boolean	equals(Object o)
List<String>	getFails() Get fails
Integer	getMaximumInvocations() Enables you to limit the number of times that the skill is notified about the same event during the course of the Input Handler.
List<String>	getMeets() Get meets
EventReportingType	getReports() Get reports For this enum type, if a value unknown to the SDK is returned the UNKNOWN_TO_SDK_VERSION enumeration value will be returned.
String	getReportsAsString() Get the underlying String value for reports.
Boolean	getShouldEndInputHandler() Whether the Input Handler should end after this event fires.
Long	getTriggerTimeMilliseconds() Adds a time constraint to the event.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Event.Builder builder()

getShouldEndInputHandler

public Boolean getShouldEndInputHandler()

Whether the Input Handler should end after this event fires. If true, the Input Handler will stop and no further events will be sent to your skill unless you call StartInputHandler again.

Returns:

shouldEndInputHandler

getMeets

public List<String> getMeets()

Get meets

Returns:

meets

getFails

public List<String> getFails()

Get fails

Returns:

fails

getReports

public EventReportingType getReports()

Get reports For this enum type, if a value unknown to the SDK is returned the UNKNOWN_TO_SDK_VERSION enumeration value will be returned. To directly return the raw String value, use getReportsAsString().

Returns:

reports

getReportsAsString

public String getReportsAsString()

Get the underlying String value for reports. Using this accessor will retrieve the raw underlying value, even if it is not present in the corresponding enumeration. For forward compatibility, it is recommended to use this approach over the enumeration.

Returns:

reports as a String value

getMaximumInvocations

public Integer getMaximumInvocations()

Enables you to limit the number of times that the skill is notified about the same event during the course of the Input Handler. The default value is 1. This property is mutually exclusive with triggerTimeMilliseconds. minimum: 1 maximum: 2048

Returns:

maximumInvocations

getTriggerTimeMilliseconds

public Long getTriggerTimeMilliseconds()

Adds a time constraint to the event. Instead of being considered whenever a raw button event occurs, an event that has this parameter will only be considered once at triggerTimeMilliseconds after the Input Handler has started. Because a time-triggered event can only fire once, the maximumInvocations value is ignored. Omit this property entirely if you do not want to time-constrain the event. minimum: 0 maximum: 90000

Returns:

triggerTimeMilliseconds

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object