com.amazon.alexa.vsk.clientlib

Interface AlexaClientManager.EventManager

Enclosing class:

AlexaClientManager

public static interface AlexaClientManager.EventManager

Method Summary

Modifier and Type	Method and Description
void	onAuthCompleted() Called from AlexaClientAuthManager when LWA access token is ready.
void	onVisibilityChanged(boolean isVisible) Called from AlexaClientLifecycleHandler when visibility change is detected.
void	reset() Reset event manager.
boolean	sendMessage(AlexaClientManager.EventType eventType, boolean statusValue, java.lang.String message) Send provided JSON message to Alexa Service with status value.
boolean	sendMessage(AlexaClientManager.EventType eventType, java.lang.String message) Send provided JSON message to Alexa Service.

Method Detail

onAuthCompleted

void onAuthCompleted()

Called from AlexaClientAuthManager when LWA access token is ready. - Post Discovery and StatusChanged event.

onVisibilityChanged

void onVisibilityChanged(boolean isVisible)

Called from AlexaClientLifecycleHandler when visibility change is detected.

Parameters:

isVisible - Current hosting application is visible or not.

sendMessage

boolean sendMessage(AlexaClientManager.EventType eventType,
                    java.lang.String message)

Send provided JSON message to Alexa Service.

Parameters:

eventType - type of current event to send. @{EventType}.

message - JSON message to send.

Returns:

True if event queued successfully. False, otherwise.

sendMessage

boolean sendMessage(AlexaClientManager.EventType eventType,
                    boolean statusValue,
                    java.lang.String message)

Send provided JSON message to Alexa Service with status value.

Parameters:

eventType - type of current event to send. @{EventType}.

statusValue - Current status value.

message - JSON message to send.

Returns:

True if event queued successfully. False, otherwise.

reset

void reset()

Reset event manager. This clears persistent state related to DISCOVERY and will cause Event manager to re-send DISCOVERY event when the next status change is detected. This should be called in situations such as capabilities change(endpoint adds or removes capabilities), realm change(alexa region the app talks to has changed and discovery must be sent to new region), or application instance id change(this field is needed for 3p skill to communicate with app, currently discovery is the only way to update this field).