Package software.amazon.awscdk.services.lex

Interface CfnBot.MessageProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.MessageProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(Stable)
public static interface CfnBot.MessageProperty
extends software.amazon.jsii.JsiiSerializable

The object that provides message text and its type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lex.*;
 MessageProperty messageProperty = MessageProperty.builder()
         .customPayload(CustomPayloadProperty.builder()
                 .value("value")
                 .build())
         .imageResponseCard(ImageResponseCardProperty.builder()
                 .title("title")
                 // the properties below are optional
                 .buttons(List.of(ButtonProperty.builder()
                         .text("text")
                         .value("value")
                         .build()))
                 .imageUrl("imageUrl")
                 .subtitle("subtitle")
                 .build())
         .plainTextMessage(PlainTextMessageProperty.builder()
                 .value("value")
                 .build())
         .ssmlMessage(SSMLMessageProperty.builder()
                 .value("value")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBot.MessageProperty.Builder	A builder for CfnBot.MessageProperty
static final class	CfnBot.MessageProperty.Jsii$Proxy	An implementation for CfnBot.MessageProperty

Method Summary

Modifier and Type	Method	Description
static CfnBot.MessageProperty.Builder	builder()
default Object	getCustomPayload()	A message in a custom format defined by the client application.
default Object	getImageResponseCard()	A message that defines a response card that the client application can show to the user.
default Object	getPlainTextMessage()	A message in plain text format.
default Object	getSsmlMessage()	A message in Speech Synthesis Markup Language (SSML).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomPayload

@Stability(Stable)
@Nullable
default Object getCustomPayload()

A message in a custom format defined by the client application.

Returns union: either IResolvable or CfnBot.CustomPayloadProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-custompayload

getImageResponseCard

@Stability(Stable)
@Nullable
default Object getImageResponseCard()

A message that defines a response card that the client application can show to the user.

Returns union: either IResolvable or CfnBot.ImageResponseCardProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-imageresponsecard

getPlainTextMessage

@Stability(Stable)
@Nullable
default Object getPlainTextMessage()

A message in plain text format.

Returns union: either IResolvable or CfnBot.PlainTextMessageProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-plaintextmessage

getSsmlMessage

@Stability(Stable)
@Nullable
default Object getSsmlMessage()

A message in Speech Synthesis Markup Language (SSML).

Returns union: either IResolvable or CfnBot.SSMLMessageProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-ssmlmessage

builder

@Stability(Stable)
static CfnBot.MessageProperty.Builder builder()

Returns:

a CfnBot.MessageProperty.Builder of CfnBot.MessageProperty