Package com.relaypro.sdk.types

These are some Java object types used in the SDK methods. Each of the objects within this package include serialized fields that are specific to that object and are used to communicate with the server. The field values are filled in when an API call utilizes one of the events or responses, or by the user who passes in values to those API methods, which are then sent in a message to the sever.

Class Summary

Class	Description
ButtonEvent	A button has been pressed on your device during a running workflow.
CallConnectedEvent	A call attempt that was ringing, progressing, or incoming is now fully connected.
CallDisconnectedEvent	A call that was once connected has become disconnected.
CallFailedEvent	A call attempt has failed to become connected.
CallProgressingEvent	The device we called is making progress on getting connected.
CallReceivedEvent	The device is receiving an inbound call request.
CallRingingEvent	The device we called is ringing.
CallStartEvent	There is a request to make an outbound call.
DeviceInfoResponse	Contains information on the device from the server after a device info query.
IncidentEvent	An incident has been resolved.
InteractionLifecycleEvent	An interaction lifecycle event has occurred.
LedInfo	Set information regarding the LED effects, such as how many rotations the LEDs should move, the number of times to perform the effect, and so on.
NotificationEvent	A device has acknowledged an alert that was sent out to a group of devices.
NotificationState	Includes information on the state of the notification event.
PlayInboxMessagesEvent	Inbox messages are being played on the device.
PromptEvent	When text-to-speech is being streamed to a Relay device, this event will mark the beginning and end of that stream delivery.
SmsEvent
SpeechEvent	You have spoken into the device by holding down the action button.
StartEvent	Your workflow has been triggered.
StopEvent	Your workflow has stopped, which might be due to normal completion after you call terminate() or from an abnormal completion error.
TargetUri	A target URI object used in most Relay API functions to send to the server.
TimerEvent	An unnamed timer has fired.
TimerFiredEvent	A named timer has fired.
Trigger	The different types of triggers that can start a workflow.

Enum Summary

Enum	Description
DeviceField	Contains information on the device.
DeviceInfoQueryType	Different information you can retrieve on the device through the Relay API calls.
DeviceMode	The different modes the device can be in, including panic and alarm.
LanguageType	The supported languages that can be used for speech, listening, or translation on the device.
LedEffect	Different effects that the Relay's LEDs can perform.
TimeoutType	The timeout type for a timer.
TimerType	Type of timer on the device.