lexruntimev2/aws.sdk.kotlin.services.lexruntimev2.model/StartConversationResponseEventStream

StartConversationResponseEventStream

sealed class StartConversationResponseEventStream

Represents a stream of events between Amazon Lex V2 and your application.

Inheritors

AudioResponseEvent

IntentResultEvent

PlaybackInterruptionEvent

TextResponseEvent

TranscriptEvent

Types

AudioResponseEvent

data class AudioResponseEvent(val value: AudioResponseEvent) : StartConversationResponseEventStream

An event sent from Amazon Lex V2 to your client application containing audio to play to the user.

data class HeartbeatEvent(val value: HeartbeatEvent) : StartConversationResponseEventStream

Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2

IntentResultEvent

data class IntentResultEvent(val value: IntentResultEvent) : StartConversationResponseEventStream

Event sent from Amazon Lex V2 to the client application containing the current state of the conversation between the user and Amazon Lex V2.

PlaybackInterruptionEvent

data class PlaybackInterruptionEvent(val value: PlaybackInterruptionEvent) : StartConversationResponseEventStream

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

object SdkUnknown : StartConversationResponseEventStream

TextResponseEvent

data class TextResponseEvent(val value: TextResponseEvent) : StartConversationResponseEventStream

The event sent from Amazon Lex V2 to your application with text to present to the user.

TranscriptEvent

data class TranscriptEvent(val value: TranscriptEvent) : StartConversationResponseEventStream

Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.

Functions

asAudioResponseEvent

fun asAudioResponseEvent(): AudioResponseEvent

Casts this StartConversationResponseEventStream as a AudioResponseEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.AudioResponseEvent value. Throws an exception if the StartConversationResponseEventStream is not a AudioResponseEvent.

asAudioResponseEventOrNull

fun asAudioResponseEventOrNull(): AudioResponseEvent?

Casts this StartConversationResponseEventStream as a AudioResponseEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.AudioResponseEvent value. Returns null if the StartConversationResponseEventStream is not a AudioResponseEvent.

asHeartbeatEvent

fun asHeartbeatEvent(): HeartbeatEvent

Casts this StartConversationResponseEventStream as a HeartbeatEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.HeartbeatEvent value. Throws an exception if the StartConversationResponseEventStream is not a HeartbeatEvent.

asHeartbeatEventOrNull

fun asHeartbeatEventOrNull(): HeartbeatEvent?

Casts this StartConversationResponseEventStream as a HeartbeatEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.HeartbeatEvent value. Returns null if the StartConversationResponseEventStream is not a HeartbeatEvent.

asIntentResultEvent

fun asIntentResultEvent(): IntentResultEvent

Casts this StartConversationResponseEventStream as a IntentResultEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.IntentResultEvent value. Throws an exception if the StartConversationResponseEventStream is not a IntentResultEvent.

asIntentResultEventOrNull

fun asIntentResultEventOrNull(): IntentResultEvent?

Casts this StartConversationResponseEventStream as a IntentResultEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.IntentResultEvent value. Returns null if the StartConversationResponseEventStream is not a IntentResultEvent.

asPlaybackInterruptionEvent

fun asPlaybackInterruptionEvent(): PlaybackInterruptionEvent

Casts this StartConversationResponseEventStream as a PlaybackInterruptionEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.PlaybackInterruptionEvent value. Throws an exception if the StartConversationResponseEventStream is not a PlaybackInterruptionEvent.

asPlaybackInterruptionEventOrNull

fun asPlaybackInterruptionEventOrNull(): PlaybackInterruptionEvent?

Casts this StartConversationResponseEventStream as a PlaybackInterruptionEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.PlaybackInterruptionEvent value. Returns null if the StartConversationResponseEventStream is not a PlaybackInterruptionEvent.

asTextResponseEvent

fun asTextResponseEvent(): TextResponseEvent

Casts this StartConversationResponseEventStream as a TextResponseEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.TextResponseEvent value. Throws an exception if the StartConversationResponseEventStream is not a TextResponseEvent.

asTextResponseEventOrNull

fun asTextResponseEventOrNull(): TextResponseEvent?

Casts this StartConversationResponseEventStream as a TextResponseEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.TextResponseEvent value. Returns null if the StartConversationResponseEventStream is not a TextResponseEvent.

asTranscriptEvent

fun asTranscriptEvent(): TranscriptEvent

Casts this StartConversationResponseEventStream as a TranscriptEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.TranscriptEvent value. Throws an exception if the StartConversationResponseEventStream is not a TranscriptEvent.

asTranscriptEventOrNull

fun asTranscriptEventOrNull(): TranscriptEvent?

Casts this StartConversationResponseEventStream as a TranscriptEvent and retrieves its aws.sdk.kotlin.services.lexruntimev2.model.TranscriptEvent value. Returns null if the StartConversationResponseEventStream is not a TranscriptEvent.