relay-dotnet
Public Member Functions | Static Public Member Functions | Properties | List of all members
RelayDotNet.EventType Class Reference

Events that can be sent from the Relay server to your workflow. More...

Public Member Functions

 EventType (string name, string serializedName)
 
- Public Member Functions inherited from RelayDotNet.SerializedType
 SerializedType (string name, string serializedName)
 
override string ToString ()
 

Static Public Member Functions

static bool TryParseSerializedName (string serializedName, out EventType result)
 

Properties

static EventType Start [get]
 Your workflow has been triggered. More...
 
static EventType Stop [get]
 
static EventType InteractionLifecycle [get]
 
static EventType Timer [get]
 An unnamed timer has fired. More...
 
static EventType TimerFired [get]
 A named timer has fired. More...
 
static EventType Prompt [get]
 
static EventType Speech [get]
 
static EventType Progress [get]
 Your workflow is progressing. More...
 
static EventType Button [get]
 
static EventType Notification [get]
 A device has acknowledged an alert that was sent out to a group of devices. More...
 
static EventType Sms [get]
 A text message event. More...
 
static EventType Audio [get]
 An audio file is being played on the device. More...
 
static EventType Incident [get]
 An incident has been resolved. More...
 
static EventType CallStartRequest [get]
 
static EventType CallReceived [get]
 The device is receiving an inbound call request. This event can occur on the callee. More...
 
static EventType CallRinging [get]
 
static EventType CallProgressing [get]
 
static EventType CallConnected [get]
 
static EventType CallDisconnected [get]
 
static EventType CallFailed [get]
 
static EventType PlayInboxMessage [get]
 Inbox messages are being played on the device. More...
 
- Properties inherited from RelayDotNet.SerializedType
string Name [get]
 
string SerializedName [get]
 

Detailed Description

Events that can be sent from the Relay server to your workflow.

Constructor & Destructor Documentation

◆ EventType()

RelayDotNet.EventType.EventType ( string  name,
string  serializedName 
)
inline

Member Function Documentation

◆ TryParseSerializedName()

static bool RelayDotNet.EventType.TryParseSerializedName ( string  serializedName,
out EventType  result 
)
inlinestatic

Property Documentation

◆ Audio

EventType RelayDotNet.EventType.Audio
staticget

An audio file is being played on the device.

◆ Button

EventType RelayDotNet.EventType.Button
staticget

A button has been pressed on your device during a running workflow. This event occurs on a single, double or triple tap of the action button or a tap of the assistant button. Note this is separate from a button trigger.

◆ CallConnected

EventType RelayDotNet.EventType.CallConnected
staticget

A call attempt that was ringing, progressing, or incoming is now fully connected. This event can occur on both the caller and the callee.

◆ CallDisconnected

EventType RelayDotNet.EventType.CallDisconnected
staticget

A call that was once connected has become disconnected. This event can occur on both the caller and the callee.

◆ CallFailed

EventType RelayDotNet.EventType.CallFailed
staticget

A call failed to get connected. This event can occur on both the caller and the callee.

◆ CallProgressing

EventType RelayDotNet.EventType.CallProgressing
staticget

The device we called is making progress on getting connected. This may be interspersed with on_call_ringing. This event can occur on the caller.

◆ CallReceived

EventType RelayDotNet.EventType.CallReceived
staticget

The device is receiving an inbound call request. This event can occur on the callee.

◆ CallRinging

EventType RelayDotNet.EventType.CallRinging
staticget

The device we called is ringing. We are waiting for them to answer. This event can occur on the caller.

◆ CallStartRequest

EventType RelayDotNet.EventType.CallStartRequest
staticget

There is a request to make an outbound call. This event can occur on the caller after using the "Call X" voice command on the Assistant.

◆ Incident

EventType RelayDotNet.EventType.Incident
staticget

An incident has been resolved.

◆ InteractionLifecycle

EventType RelayDotNet.EventType.InteractionLifecycle
staticget

An interaction lifecycle event has occurred. This could indicate that an interaction has started, resumed, been suspended, ended, or failed.

◆ Notification

EventType RelayDotNet.EventType.Notification
staticget

A device has acknowledged an alert that was sent out to a group of devices.

◆ PlayInboxMessage

EventType RelayDotNet.EventType.PlayInboxMessage
staticget

Inbox messages are being played on the device.

◆ Progress

EventType RelayDotNet.EventType.Progress
staticget

Your workflow is progressing.

◆ Prompt

EventType RelayDotNet.EventType.Prompt
staticget

When a text-to-speech is being streamed to a Relay device, this event will mark the beginning and end of that stream delivery.

◆ Sms

EventType RelayDotNet.EventType.Sms
staticget

A text message event.

◆ Speech

EventType RelayDotNet.EventType.Speech
staticget

You have spoken into the device by holding down the action button. Typically seen when the listen() funciton is happening on a device.

◆ Start

EventType RelayDotNet.EventType.Start
staticget

Your workflow has been triggered.

◆ Stop

EventType RelayDotNet.EventType.Stop
staticget

Your workflow has stopped, which might be due to a normal completion after you call terminate() or from an abnormal completion error.

◆ Timer

EventType RelayDotNet.EventType.Timer
staticget

An unnamed timer has fired.

◆ TimerFired

EventType RelayDotNet.EventType.TimerFired
staticget

A named timer has fired.


The documentation for this class was generated from the following file: