Index (Relay SDK for Java)

A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages

A

acknowledged - Variable in class com.relaypro.sdk.types.NotificationState: List of devices that have acknowledged the alert.
address - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
Address - com.relaypro.sdk.types.DeviceInfoQueryType
addWorkflow(String, Workflow) - Static method in class com.relaypro.sdk.Relay: Adds a workflow to the path.
Alarm - com.relaypro.sdk.types.DeviceMode
alert(String, String, String, String) - Method in class com.relaypro.sdk.Relay: Sends out an alert to the specified group of devices and the Relay Dash.
answerCall(String, String) - Method in class com.relaypro.sdk.Relay: Answers a call on your device.
args - Variable in class com.relaypro.sdk.types.Trigger

B

battery - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
Battery - com.relaypro.sdk.types.DeviceInfoQueryType
breathe(String, String, int) - Method in class com.relaypro.sdk.Relay: Switches all the LEDs on a device to a certain color and creates a 'breathing' effect, where the LEDs will slowly light up a specified number of times.
BREATHE - com.relaypro.sdk.types.LedEffect
broadcast(String, String, String, String) - Method in class com.relaypro.sdk.Relay: Broadcasts a message to a group of devices.
button - Variable in class com.relaypro.sdk.types.ButtonEvent: Which button was pressed.
ButtonEvent - Class in com.relaypro.sdk.types: A button has been pressed on your device during a running workflow.
ButtonEvent() - Constructor for class com.relaypro.sdk.types.ButtonEvent

C

CallConnectedEvent - Class in com.relaypro.sdk.types: A call attempt that was ringing, progressing, or incoming is now fully connected.
CallConnectedEvent() - Constructor for class com.relaypro.sdk.types.CallConnectedEvent
CallDisconnectedEvent - Class in com.relaypro.sdk.types: A call that was once connected has become disconnected.
CallDisconnectedEvent() - Constructor for class com.relaypro.sdk.types.CallDisconnectedEvent
CallFailedEvent - Class in com.relaypro.sdk.types: A call attempt has failed to become connected.
CallFailedEvent() - Constructor for class com.relaypro.sdk.types.CallFailedEvent
callId - Variable in class com.relaypro.sdk.types.CallConnectedEvent: The ID of this new call.
callId - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: The ID of this existing call.
callId - Variable in class com.relaypro.sdk.types.CallFailedEvent: The ID of this new call.
callId - Variable in class com.relaypro.sdk.types.CallProgressingEvent: The ID of this new call.
callId - Variable in class com.relaypro.sdk.types.CallReceivedEvent: The ID of this new call.
callId - Variable in class com.relaypro.sdk.types.CallRingingEvent: The ID of this new call.
CallProgressingEvent - Class in com.relaypro.sdk.types: The device we called is making progress on getting connected.
CallProgressingEvent() - Constructor for class com.relaypro.sdk.types.CallProgressingEvent
CallReceivedEvent - Class in com.relaypro.sdk.types: The device is receiving an inbound call request.
CallReceivedEvent() - Constructor for class com.relaypro.sdk.types.CallReceivedEvent
CallRingingEvent - Class in com.relaypro.sdk.types: The device we called is ringing.
CallRingingEvent() - Constructor for class com.relaypro.sdk.types.CallRingingEvent
CallStartEvent - Class in com.relaypro.sdk.types: There is a request to make an outbound call.
CallStartEvent() - Constructor for class com.relaypro.sdk.types.CallStartEvent
cancelAlert(String, String) - Method in class com.relaypro.sdk.Relay: Cancels an alert that was sent to a group of devices.
cancelBroadcast(String, String) - Method in class com.relaypro.sdk.Relay: Cancels the broadcast that was sent to a group of devices.
cancelled - Variable in class com.relaypro.sdk.types.NotificationState: List of devices where the alert has been cancelled.
Channel - com.relaypro.sdk.types.DeviceField
Chinese - com.relaypro.sdk.types.LanguageType
clearTimer(String) - Method in class com.relaypro.sdk.Relay: Clears the specified timer.
clone() - Method in class com.relaypro.sdk.Workflow
com.relaypro.sdk - package com.relaypro.sdk: These are the classes that provide the main implementation of the SDK.
com.relaypro.sdk.types - package com.relaypro.sdk.types: These are some Java object types used in the SDK methods.
connectTimeEpoch - Variable in class com.relaypro.sdk.types.CallConnectedEvent: A timestamp of when the call was connected, in epoch seconds.
connectTimeEpoch - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: A timestamp of when the call was connected, in epoch seconds.
connectTimeEpoch - Variable in class com.relaypro.sdk.types.CallFailedEvent: A timestamp of when the call was connected, in epoch seconds.
created - Variable in class com.relaypro.sdk.types.NotificationState: List of devices on which the alert was created.
createIncident(String, String) - Method in class com.relaypro.sdk.Relay: Creates an incident that will alert the Relay Dash.

D

DEVICE - Static variable in class com.relaypro.sdk.RelayUri
DEVICE_PATTERN - Static variable in class com.relaypro.sdk.RelayUri
DeviceField - Enum in com.relaypro.sdk.types: Contains information on the device.
deviceId - Variable in class com.relaypro.sdk.types.CallConnectedEvent: The ID of the other device.
deviceId - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: The ID of the other device.
deviceId - Variable in class com.relaypro.sdk.types.CallFailedEvent: The ID of the other device.
deviceId - Variable in class com.relaypro.sdk.types.CallProgressingEvent: The ID of the other device.
deviceId - Variable in class com.relaypro.sdk.types.CallReceivedEvent: The ID of the other device.
deviceId - Variable in class com.relaypro.sdk.types.CallRingingEvent: The ID of the other device.
deviceId(String) - Static method in class com.relaypro.sdk.RelayUri: Creates a URN from a device ID.
DeviceInfoQueryType - Enum in com.relaypro.sdk.types: Different information you can retrieve on the device through the Relay API calls.
DeviceInfoResponse - Class in com.relaypro.sdk.types: Contains information on the device from the server after a device info query.
DeviceInfoResponse() - Constructor for class com.relaypro.sdk.types.DeviceInfoResponse
DeviceMode - Enum in com.relaypro.sdk.types: The different modes the device can be in, including panic and alarm.
deviceName - Variable in class com.relaypro.sdk.types.CallConnectedEvent: The name of the other device.
deviceName - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: The name of the other device.
deviceName - Variable in class com.relaypro.sdk.types.CallFailedEvent: The name of the other device.
deviceName - Variable in class com.relaypro.sdk.types.CallProgressingEvent: The name of the other device.
deviceName - Variable in class com.relaypro.sdk.types.CallReceivedEvent: The name of the other device.
deviceName - Variable in class com.relaypro.sdk.types.CallRingingEvent: The name of the other device.
deviceName(String) - Static method in class com.relaypro.sdk.RelayUri: Creates a URN from a device name.
direction - Variable in class com.relaypro.sdk.types.CallConnectedEvent: Call direction relative to this device: inbound or outbound.
direction - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: Call direction relative to this device: inbound or outbound.
direction - Variable in class com.relaypro.sdk.types.CallFailedEvent: Call direction relative to this device: inbound or outbound.
direction - Variable in class com.relaypro.sdk.types.CallProgressingEvent: Call direction relative to this device: inbound or outbound.
direction - Variable in class com.relaypro.sdk.types.CallReceivedEvent: Call direction relative to this device: inbound or outbound.
direction - Variable in class com.relaypro.sdk.types.CallRingingEvent: Call direction relative to this device: inbound or outbound.
disableHomeChannel(String) - Method in class com.relaypro.sdk.Relay: Disables the home channel on the device.
disableLocation(String) - Method in class com.relaypro.sdk.Relay: Disables location services on a device.
Dutch - com.relaypro.sdk.types.LanguageType

E

enableHomeChannel(String) - Method in class com.relaypro.sdk.Relay: Enables the home channel on the device.
enableLocation(String) - Method in class com.relaypro.sdk.Relay: Enables location services on a device.
endInteraction(String) - Method in class com.relaypro.sdk.Relay: Ends an interaction with the user.
endTimeEpoch - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: A timestamp of when the call was disconnected, in epoch seconds.
endTimeEpoch - Variable in class com.relaypro.sdk.types.CallFailedEvent: A timestamp of when the call was disconnected, in epoch seconds.
English - com.relaypro.sdk.types.LanguageType
event - Variable in class com.relaypro.sdk.types.NotificationEvent: The type of notification event, such as "ack_event".

F

fetchDevice(String, String, String, String, String) - Method in class com.relaypro.sdk.Relay: A convenience method for getting all the details of a device.
flash(String, String, int) - Method in class com.relaypro.sdk.Relay: Switches all the LEDs on a device to a certain color and flashes them a specified number of times.
FLASH - com.relaypro.sdk.types.LedEffect
French - com.relaypro.sdk.types.LanguageType

G

German - com.relaypro.sdk.types.LanguageType
getDeviceAddress(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the address of a targeted device.
getDeviceBattery(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the battery of a targeted device.
getDeviceCoordinates(String, boolean) - Method in class com.relaypro.sdk.Relay: Retrieves the coordinates of the device's location.
getDeviceId(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the ID of a targeted device.
getDeviceIndoorLocation(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the indoor location of a targeted device.
getDeviceLatLong(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the latitude and longitude coordinates of a targeted device.
getDeviceLocation(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the location of a targeted device.
getDeviceLocationEnabled(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns whether the location services on a device are enabled.
getDeviceName(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the name of a targeted device.
getDeviceType(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the device type of a targeted device, i.e.
getNumberVar(String, int) - Method in class com.relaypro.sdk.Relay: Retrieves a variable that was set either during workflow registration or through the set_var() function of type integer.
getSourceUriFromStartEvent(StartEvent) - Static method in class com.relaypro.sdk.Relay: Parses out and retrieves the source URN from a Start Event.
getUnreadInboxSize(String) - Method in class com.relaypro.sdk.Relay: Retrieves the number of messages in a device's inbox.
getUserProfile(String, boolean) - Method in class com.relaypro.sdk.Relay: Returns the user profile of a targeted device.
getVar(String, String) - Method in class com.relaypro.sdk.Relay: Retrieves a variable that was set either during workflow registration or through the set_var() function.
GROUP - Static variable in class com.relaypro.sdk.RelayUri
groupId(String) - Static method in class com.relaypro.sdk.RelayUri: Creates a URN from a group ID.
groupMember(String, String) - Static method in class com.relaypro.sdk.RelayUri: Creates a URN for a group member.
groupName(String) - Static method in class com.relaypro.sdk.RelayUri: Creates a URN from a group name.

H

handleTextMessage(Session, String) - Method in class com.relaypro.sdk.JakartaWebsocketReceiver
hangupCall(String, String) - Method in class com.relaypro.sdk.Relay: Ends a call on your device.
Hindi - com.relaypro.sdk.types.LanguageType
HRS - com.relaypro.sdk.types.TimeoutType

I

Icelandic - com.relaypro.sdk.types.LanguageType
id - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
Id - com.relaypro.sdk.types.DeviceInfoQueryType
ID - Static variable in class com.relaypro.sdk.RelayUri
IncidentEvent - Class in com.relaypro.sdk.types: An incident has been resolved.
IncidentEvent() - Constructor for class com.relaypro.sdk.types.IncidentEvent
incidentId - Variable in class com.relaypro.sdk.types.IncidentEvent: The ID of the incident.
indoor_location - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
IndoorLocation - com.relaypro.sdk.types.DeviceInfoQueryType
INTERACTION - Static variable in class com.relaypro.sdk.RelayUri
INTERACTION_URI_ID - Static variable in class com.relaypro.sdk.RelayUri
INTERACTION_URI_NAME - Static variable in class com.relaypro.sdk.RelayUri
InteractionLifecycleEvent - Class in com.relaypro.sdk.types: An interaction lifecycle event has occurred.
InteractionLifecycleEvent() - Constructor for class com.relaypro.sdk.types.InteractionLifecycleEvent
interactionName(String) - Static method in class com.relaypro.sdk.RelayUri: Creates a URN from an interaction name.
INTERVAL - com.relaypro.sdk.types.TimerType
isGroupMember(String, String) - Method in class com.relaypro.sdk.Relay: Checks whether a device is a member of a particular group.
isInteractionUri(String) - Static method in class com.relaypro.sdk.RelayUri: Checks if the URN is for an interaction.
isRelayUri(String) - Static method in class com.relaypro.sdk.RelayUri: Checks if the URN is a Relay URN.
isTypeEnded() - Method in class com.relaypro.sdk.types.InteractionLifecycleEvent: Returns whether the InteractionLifecycleEvent has a type of "ended".
isTypeResumed() - Method in class com.relaypro.sdk.types.InteractionLifecycleEvent: Returns whether the InteractionLifecycleEvent has a type of "resumed".
isTypeStarted() - Method in class com.relaypro.sdk.types.InteractionLifecycleEvent: Returns whether the InteractionLifecycleEvent has a type of "started".
isTypeSuspended() - Method in class com.relaypro.sdk.types.InteractionLifecycleEvent: Returns whether the InteractionLifecycleEvent has a type of "suspended".
Italian - com.relaypro.sdk.types.LanguageType

J

JakartaWebsocketReceiver - Class in com.relaypro.sdk: Map the websocket API (onOpen, handleTextMessage, onError, onClose) to the Relay methods.
JakartaWebsocketReceiver() - Constructor for class com.relaypro.sdk.JakartaWebsocketReceiver
Japanese - com.relaypro.sdk.types.LanguageType

K

Korean - com.relaypro.sdk.types.LanguageType

L

Label - com.relaypro.sdk.types.DeviceField
LanguageType - Enum in com.relaypro.sdk.types: The supported languages that can be used for speech, listening, or translation on the device.
latlong - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
LatLong - com.relaypro.sdk.types.DeviceInfoQueryType
LedEffect - Enum in com.relaypro.sdk.types: Different effects that the Relay's LEDs can perform.
LedInfo - Class in com.relaypro.sdk.types: 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.
LedInfo() - Constructor for class com.relaypro.sdk.types.LedInfo
ledMap - Variable in class com.relaypro.sdk.types.LedInfo
listen(String, String) - Method in class com.relaypro.sdk.Relay: Listens for the user to speak into the device.
listen(String, String, String[], boolean, LanguageType, int) - Method in class com.relaypro.sdk.Relay: Listens for the user to speak into the device.
location_enabled - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
LocationEnabled - com.relaypro.sdk.types.DeviceField
LocationEnabled - com.relaypro.sdk.types.DeviceInfoQueryType
logMessage(String, String) - Method in class com.relaypro.sdk.Relay: Log an analytics event from a workflow with the specified content and under a specified category.
logUserMessage(String, String, String) - Method in class com.relaypro.sdk.Relay: Log an analytic event from a workflow with the specified content and under a specified category.

M

MINS - com.relaypro.sdk.types.TimeoutType
MS - com.relaypro.sdk.types.TimeoutType

N

name - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
name - Variable in class com.relaypro.sdk.types.NotificationEvent: The name of the alert.
name - Variable in class com.relaypro.sdk.types.TimerEvent
name - Variable in class com.relaypro.sdk.types.TimerFiredEvent: Name of the timer.
Name - com.relaypro.sdk.types.DeviceInfoQueryType
NAME - Static variable in class com.relaypro.sdk.RelayUri
None - com.relaypro.sdk.types.DeviceMode
Norwegian - com.relaypro.sdk.types.LanguageType
NotificationEvent - Class in com.relaypro.sdk.types: A device has acknowledged an alert that was sent out to a group of devices.
NotificationEvent() - Constructor for class com.relaypro.sdk.types.NotificationEvent
notificationState - Variable in class com.relaypro.sdk.types.NotificationEvent: Contains information regarding the state of the notification, such as a list of devices who have acknowledged the alert, a list of devices on which the alert has been created, and more.
NotificationState - Class in com.relaypro.sdk.types: Includes information on the state of the notification event.
NotificationState() - Constructor for class com.relaypro.sdk.types.NotificationState

O

OFF - com.relaypro.sdk.types.LedEffect
onButton(Relay, ButtonEvent) - Method in class com.relaypro.sdk.Workflow: The talk or assistant button has been pressed.
onCallConnected(Relay, CallConnectedEvent) - Method in class com.relaypro.sdk.Workflow: A call attempt that was ringing, progressing, or incoming is now fully connected.
onCallDisconnected(Relay, CallDisconnectedEvent) - Method in class com.relaypro.sdk.Workflow: A call that was once connected has become disconnected.
onCallFailed(Relay, CallFailedEvent) - Method in class com.relaypro.sdk.Workflow: A call failed to get connected.
onCallProgressing(Relay, CallProgressingEvent) - Method in class com.relaypro.sdk.Workflow: The device we called is making progress on getting connected.
onCallReceived(Relay, CallReceivedEvent) - Method in class com.relaypro.sdk.Workflow: The device is receiving an inbound call request.
onCallRinging(Relay, CallRingingEvent) - Method in class com.relaypro.sdk.Workflow: The device we called is ringing.
onCallStartRequest(Relay, CallStartEvent) - Method in class com.relaypro.sdk.Workflow: There is a request to make an outbound call.
onClose(Session, CloseReason) - Method in class com.relaypro.sdk.JakartaWebsocketReceiver
onError(Session, Throwable) - Method in class com.relaypro.sdk.JakartaWebsocketReceiver
onIncident(Relay, IncidentEvent) - Method in class com.relaypro.sdk.Workflow: An incident has been created.
onInteractionLifecycle(Relay, InteractionLifecycleEvent) - Method in class com.relaypro.sdk.Workflow: An interaction is starting, resuming, or ending.
onnet - Variable in class com.relaypro.sdk.types.CallConnectedEvent: Whether or not the other party is a Relay-hosted device.
onnet - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: Whether or not the other party is a Relay-hosted device.
onnet - Variable in class com.relaypro.sdk.types.CallFailedEvent: Whether or not the other party is a Relay-hosted device.
onnet - Variable in class com.relaypro.sdk.types.CallProgressingEvent: Whether or not the other party is a Relay-hosted device.
onnet - Variable in class com.relaypro.sdk.types.CallReceivedEvent: Whether or not the other party is a Relay-hosted device.
onnet - Variable in class com.relaypro.sdk.types.CallRingingEvent: Whether or not the other party is a Relay-hosted device.
onNotification(Relay, NotificationEvent) - Method in class com.relaypro.sdk.Workflow: A broadcast or alert has been sent.
onOpen(Session, String) - Method in class com.relaypro.sdk.JakartaWebsocketReceiver
onPlayInboxMessage(Relay, PlayInboxMessagesEvent) - Method in class com.relaypro.sdk.Workflow: Audio is streaming in regarding a missed message.
onPrompt(Relay, PromptEvent) - Method in class com.relaypro.sdk.Workflow: Text-to-speech stream has started or stopped on the device.
onSms(Relay, SmsEvent) - Method in class com.relaypro.sdk.Workflow: A callback for the SmsEvent (TBD).
onSpeech(Relay, SpeechEvent) - Method in class com.relaypro.sdk.Workflow: You have spoken into the device, typically when listen() is happening.
onStart(Relay, StartEvent) - Method in class com.relaypro.sdk.Workflow: Your workflow is starting.
onStop(Relay, StopEvent) - Method in class com.relaypro.sdk.Workflow: Your workflow is stopping.
onTimer(Relay, TimerEvent) - Method in class com.relaypro.sdk.Workflow: An unnamed timer has fired.
onTimerFired(Relay, TimerFiredEvent) - Method in class com.relaypro.sdk.Workflow: A named timer has fired.

P

Panic - com.relaypro.sdk.types.DeviceMode
parseDeviceId(String) - Static method in class com.relaypro.sdk.RelayUri: Parses out a device ID from a device or interaction URN.
parseDeviceName(String) - Static method in class com.relaypro.sdk.RelayUri: Parses out a device name from a device or interaction URN.
parseGroupId(String) - Static method in class com.relaypro.sdk.RelayUri: Parses out a group ID from a group URN.
parseGroupName(String) - Static method in class com.relaypro.sdk.RelayUri: Parses out a group name from a group URN.
parseInteraction(String) - Static method in class com.relaypro.sdk.RelayUri: Parses out the name of an interaction from an interaction URN.
placeCall(String, String) - Method in class com.relaypro.sdk.Relay: Places a call to another device.
play(String, String) - Method in class com.relaypro.sdk.Relay: Plays a custom audio file that was uploaded by the user.
playAndWait(String, String) - Method in class com.relaypro.sdk.Relay: Plays a custom audio file that was uploaded by the user.
PlayInboxMessagesEvent - Class in com.relaypro.sdk.types: Inbox messages are being played on the device.
PlayInboxMessagesEvent() - Constructor for class com.relaypro.sdk.types.PlayInboxMessagesEvent
playUnreadInboxMessages(String) - Method in class com.relaypro.sdk.Relay: Play a targeted device's inbox messages.
Polish - com.relaypro.sdk.types.LanguageType
Portuguese - com.relaypro.sdk.types.LanguageType
PromptEvent - Class in com.relaypro.sdk.types: When text-to-speech is being streamed to a Relay device, this event will mark the beginning and end of that stream delivery.
PromptEvent() - Constructor for class com.relaypro.sdk.types.PromptEvent

R

rainbow(String, int) - Method in class com.relaypro.sdk.Relay: Switches all the LEDs on to a configured rainbow pattern and rotates the rainbow a specified number of times.
RAINBOW - com.relaypro.sdk.types.LedEffect
reason - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: The reason discovered for disconnection of this call.
reason - Variable in class com.relaypro.sdk.types.CallFailedEvent: The reason discovered for failure of this call.
reason - Variable in class com.relaypro.sdk.types.IncidentEvent: The reason for the incident's resolution.
reason - Variable in class com.relaypro.sdk.types.InteractionLifecycleEvent: Only set if type is "failed".
reason - Variable in class com.relaypro.sdk.types.StopEvent: The reason for the workflow stopping.
receiveMessage(Session, String) - Static method in class com.relaypro.sdk.Relay
Relay - Class in com.relaypro.sdk: Actions and utilities that can be performed on a Relay device.
RelayUri - Class in com.relaypro.sdk: Utilities for working with URIs (aka URNs) for Relay devices, groups, and interactions.
RelayUri() - Constructor for class com.relaypro.sdk.RelayUri
resolveIncident(String, String) - Method in class com.relaypro.sdk.Relay: Resolves an incident that was created.
ROOT - Static variable in class com.relaypro.sdk.RelayUri
rotate(String, String, int) - Method in class com.relaypro.sdk.Relay: Switches all the LEDs on a device to a certain color and rotates them a specified number of times.
ROTATE - com.relaypro.sdk.types.LedEffect
Russian - com.relaypro.sdk.types.LanguageType

S

say(String, String) - Method in class com.relaypro.sdk.Relay: Utilizes text to speech capabilities to make the device 'speak' to the user.
say(String, String, LanguageType) - Method in class com.relaypro.sdk.Relay: Utilizes text to speech capabilities to make the device 'speak' to the user.
sayAndWait(String, String) - Method in class com.relaypro.sdk.Relay: Utilizes text to speech capabilities to make the device 'speak' to the user.
sayAndWait(String, String, LanguageType) - Method in class com.relaypro.sdk.Relay: Utilizes text to speech capabilities to make the device 'speak' to the user.
SCHEME - Static variable in class com.relaypro.sdk.RelayUri
SECS - com.relaypro.sdk.types.TimeoutType
setChannel(String, String, boolean, boolean) - Method in class com.relaypro.sdk.Relay: Sets the channel that a device is on.
setColor(String, String) - Method in class com.relaypro.sdk.types.LedInfo
setCount(int) - Method in class com.relaypro.sdk.types.LedInfo
setDeviceName(String, String) - Method in class com.relaypro.sdk.Relay: Sets the name of a targeted device and updates it on the Relay Dash.
setDuration(int) - Method in class com.relaypro.sdk.types.LedInfo
setPatterRepeats(int) - Method in class com.relaypro.sdk.types.LedInfo
setRepeatDelay(int) - Method in class com.relaypro.sdk.types.LedInfo
setRotations(int) - Method in class com.relaypro.sdk.types.LedInfo
setTimer(TimerType, String, long, TimeoutType) - Method in class com.relaypro.sdk.Relay: Serves as a named timer that can be either interval or timeout.
setUserProfile(String, String, boolean) - Method in class com.relaypro.sdk.Relay: Sets the profile of a user by updating the username.
setVar(String, String) - Method in class com.relaypro.sdk.Relay: Sets a variable with the corresponding name and value.
SmsEvent - Class in com.relaypro.sdk.types
SmsEvent() - Constructor for class com.relaypro.sdk.types.SmsEvent
sourceUri - Variable in class com.relaypro.sdk.types.ButtonEvent: The URN of the device whose button was pressed.
sourceUri - Variable in class com.relaypro.sdk.types.InteractionLifecycleEvent: The interaction URN.
sourceUri - Variable in class com.relaypro.sdk.types.NotificationEvent: The device that was listed as the originator of the alert.
Spanish - com.relaypro.sdk.types.LanguageType
SpeechEvent - Class in com.relaypro.sdk.types: You have spoken into the device by holding down the action button.
SpeechEvent() - Constructor for class com.relaypro.sdk.types.SpeechEvent
StartEvent - Class in com.relaypro.sdk.types: Your workflow has been triggered.
StartEvent() - Constructor for class com.relaypro.sdk.types.StartEvent
startInteraction(String, String) - Method in class com.relaypro.sdk.Relay: Starts an interaction with the user.
startInteraction(String, String, Object) - Method in class com.relaypro.sdk.Relay: Starts an interaction with the user.
startTimeEpoch - Variable in class com.relaypro.sdk.types.CallConnectedEvent: A timestamp of when the call was requested, in epoch seconds.
startTimeEpoch - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: A timestamp of when the call was requested, in epoch seconds.
startTimeEpoch - Variable in class com.relaypro.sdk.types.CallFailedEvent: A timestamp of when the call was requested, in epoch seconds.
startTimeEpoch - Variable in class com.relaypro.sdk.types.CallProgressingEvent: A timestamp of when the call was requested, in epoch seconds.
startTimeEpoch - Variable in class com.relaypro.sdk.types.CallReceivedEvent: A timestamp of when the call was requested, in epoch seconds.
startTimeEpoch - Variable in class com.relaypro.sdk.types.CallRingingEvent: A timestamp of when the call was requested, in epoch seconds.
startTimer(int) - Method in class com.relaypro.sdk.Relay: Starts an unnamed timer, meaning this will be the only timer on your device.
startWorkflow(Session, String) - Static method in class com.relaypro.sdk.Relay
STATIC - com.relaypro.sdk.types.LedEffect
StopEvent - Class in com.relaypro.sdk.types: Your workflow has stopped, which might be due to normal completion after you call terminate() or from an abnormal completion error.
StopEvent() - Constructor for class com.relaypro.sdk.types.StopEvent
stopPlayback(String, String[]) - Method in class com.relaypro.sdk.Relay: Stops a playback request on the device.
stopTimer() - Method in class com.relaypro.sdk.Relay: Stops an unnamed timer.
stopWorkflow(Session, String) - Static method in class com.relaypro.sdk.Relay
Swedish - com.relaypro.sdk.types.LanguageType
switchAllLedOff(String) - Method in class com.relaypro.sdk.Relay: Switches all of the LEDs on a device off.
switchAllLedOn(String, String) - Method in class com.relaypro.sdk.Relay: Switches all the LEDs on a device on to a specified color.
switchLedOn(String, int, String) - Method in class com.relaypro.sdk.Relay: Switches on an LED at a particular index to a specified color.

T

taps - Variable in class com.relaypro.sdk.types.ButtonEvent: The number of times the button was pressed.
TargetUri - Class in com.relaypro.sdk.types: A target URI object used in most Relay API functions to send to the server.
TargetUri(String[]) - Constructor for class com.relaypro.sdk.types.TargetUri
terminate() - Method in class com.relaypro.sdk.Relay: Terminates a workflow.
timedOut - Variable in class com.relaypro.sdk.types.NotificationState: List of devices on which the alert timed out
TIMEOUT - com.relaypro.sdk.types.TimerType
TimeoutType - Enum in com.relaypro.sdk.types: The timeout type for a timer.
TimerEvent - Class in com.relaypro.sdk.types: An unnamed timer has fired.
TimerEvent() - Constructor for class com.relaypro.sdk.types.TimerEvent
TimerFiredEvent - Class in com.relaypro.sdk.types: A named timer has fired.
TimerFiredEvent() - Constructor for class com.relaypro.sdk.types.TimerFiredEvent
TimerType - Enum in com.relaypro.sdk.types: Type of timer on the device.
translate(String, LanguageType, LanguageType) - Method in class com.relaypro.sdk.Relay: Translates text from one language to another.
trigger - Variable in class com.relaypro.sdk.types.StartEvent: The type of trigger that started your workflow.
Trigger - Class in com.relaypro.sdk.types: The different types of triggers that can start a workflow.
Trigger() - Constructor for class com.relaypro.sdk.types.Trigger
triggerWorkflow(String, String, String, String, String, String, String[], Map<String, String>) - Method in class com.relaypro.sdk.Relay: A convenience method for sending an HTTP trigger to the Relay server.
Turkish - com.relaypro.sdk.types.LanguageType
type - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
type - Variable in class com.relaypro.sdk.types.IncidentEvent: Can be either "resolved" or "cancelled".
type - Variable in class com.relaypro.sdk.types.InteractionLifecycleEvent: Can be either "started", "resumed", "suspended", "ended" or "failed".
type - Variable in class com.relaypro.sdk.types.Trigger
Type - com.relaypro.sdk.types.DeviceInfoQueryType

U

unsetVar(String) - Method in class com.relaypro.sdk.Relay: Unsets the value of a variable.
uri - Variable in class com.relaypro.sdk.types.CallConnectedEvent: A SIP-style URI of the other device.
uri - Variable in class com.relaypro.sdk.types.CallDisconnectedEvent: A SIP-style URI of the other device.
uri - Variable in class com.relaypro.sdk.types.CallFailedEvent: A SIP-style URI of the other device.
uri - Variable in class com.relaypro.sdk.types.CallProgressingEvent: A SIP-style URI of the other device.
uri - Variable in class com.relaypro.sdk.types.CallReceivedEvent: A SIP-style URI of the other device.
uri - Variable in class com.relaypro.sdk.types.CallRingingEvent: A SIP-style URI of the other device.
uri - Variable in class com.relaypro.sdk.types.CallStartEvent: The URI of the device to call.
uris() - Method in class com.relaypro.sdk.types.TargetUri
username - Variable in class com.relaypro.sdk.types.DeviceInfoResponse
Username - com.relaypro.sdk.types.DeviceInfoQueryType

V

value() - Method in enum com.relaypro.sdk.types.DeviceField
value() - Method in enum com.relaypro.sdk.types.DeviceInfoQueryType
value() - Method in enum com.relaypro.sdk.types.DeviceMode
value() - Method in enum com.relaypro.sdk.types.LanguageType
value() - Method in enum com.relaypro.sdk.types.LedEffect
value() - Method in enum com.relaypro.sdk.types.TimeoutType
value() - Method in enum com.relaypro.sdk.types.TimerType
valueOf(String) - Static method in enum com.relaypro.sdk.types.DeviceField: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.relaypro.sdk.types.DeviceInfoQueryType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.relaypro.sdk.types.DeviceMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.relaypro.sdk.types.LanguageType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.relaypro.sdk.types.LedEffect: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.relaypro.sdk.types.TimeoutType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.relaypro.sdk.types.TimerType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.relaypro.sdk.types.DeviceField: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.relaypro.sdk.types.DeviceInfoQueryType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.relaypro.sdk.types.DeviceMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.relaypro.sdk.types.LanguageType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.relaypro.sdk.types.LedEffect: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.relaypro.sdk.types.TimeoutType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.relaypro.sdk.types.TimerType: Returns an array containing the constants of this enum type, in the order they are declared.
vibrate(String, int[]) - Method in class com.relaypro.sdk.Relay: Makes the device vibrate in a particular pattern.

W

Workflow - Class in com.relaypro.sdk: A representation of a Relay workflow instance that can receive events from the Relay server, and is where you implement your workflow logic.
Workflow() - Constructor for class com.relaypro.sdk.Workflow

A B C D E F G H I J K L M N O P R S T U V W
All Classes All Packages