IMessageActivity interface

  • リファレンス
パッケージ:
botframework-schema
Extends
IActivity

プロパティ

attachmentLayout

複数の添付ファイルのレイアウト ヒント。 既定値: リスト。 使用可能な値は、'list'、'carousel' です。
attachments

添付 ファイル
deliveryMode

アクティビティの受信者の代替配信パスに通知する配信ヒント。 既定の配信モードは "default" です。 指定できる値は、'normal'、'notification' です。
expiration

アクティビティが "期限切れ" と見なされ、受信者に表示されない時刻。
importance

アクティビティの重要性。 指定できる値は、'low'、'normal'、'high' です。
inputHint

メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。 使用可能な値は、'acceptingInput'、'ignoringInput'、'expectingInput' です。
locale

テキスト フィールドの内容のロケール名。 ロケール名は、言語に関連付けられた ISO 639 の 2 文字または 3 文字のカルチャ コードと、国または地域に関連付けられた ISO 3166 2 文字のサブカルチャ コードの組み合わせです。 ロケール名は、有効な BCP-47 言語タグにも対応できます。
speak

読み上げるテキスト。
suggestedActions

アクティビティに対して推奨されるアクション。
summary

チャネルでカードをレンダリングできない場合に表示するテキスト。
text

メッセージのテキスト コンテンツ。
textFormat

テキスト フィールドの形式 Default:markdown。 指定できる値は、'markdown'、'plain'、'xml' です。
value

アクティビティに関連付けられている値。

継承されたプロパティ

channelData

チャネル固有のコンテンツが含まれます。
channelId

チャネルを一意に識別する ID を含みます。 チャネルによって設定されます。
conversation

アクティビティが属する会話を識別します。
entities

メッセージに記載されたエンティティを表します。
from

メッセージの送信者を識別します。
id

チャネルのアクティビティを一意に識別する ID を含みます。
localTimestamp

ISO-8601 形式で表される、メッセージのローカルの日付と時刻を格納します。 たとえば、2016-09-23T13:07:49.4714686-07:00 などです。
recipient

メッセージの受信者を識別します。
replyToId

このメッセージが応答であるメッセージの ID を格納します。
serviceUrl

チャネルのサービス エンドポイントを指定する URL が含まれています。 チャネルによって設定されます。
timestamp

ISO-8601 形式で表された、メッセージが送信された日時 (UTC) を格納します。
type

アクティビティの種類 'iActivity' が含まれています

プロパティの詳細

attachmentLayout

複数の添付ファイルのレイアウト ヒント。 既定値: リスト。 使用可能な値は、'list'、'carousel' です。

attachmentLayout?: AttachmentLayoutTypes | string

プロパティ値

AttachmentLayoutTypes | string

attachments

添付 ファイル

attachments?: Attachment[]

プロパティ値

Attachment[]

deliveryMode

アクティビティの受信者の代替配信パスに通知する配信ヒント。 既定の配信モードは "default" です。 指定できる値は、'normal'、'notification' です。

deliveryMode?: DeliveryModes | string

プロパティ値

DeliveryModes | string

expiration

アクティビティが "期限切れ" と見なされ、受信者に表示されない時刻。

expiration?: Date

プロパティ値

Date

importance

アクティビティの重要性。 指定できる値は、'low'、'normal'、'high' です。

importance?: ActivityImportance | string

プロパティ値

ActivityImportance | string

inputHint

メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。 使用可能な値は、'acceptingInput'、'ignoringInput'、'expectingInput' です。

inputHint?: InputHints | string

プロパティ値

InputHints | string

locale

テキスト フィールドの内容のロケール名。 ロケール名は、言語に関連付けられた ISO 639 の 2 文字または 3 文字のカルチャ コードと、国または地域に関連付けられた ISO 3166 2 文字のサブカルチャ コードの組み合わせです。 ロケール名は、有効な BCP-47 言語タグにも対応できます。

locale?: string

プロパティ値

string

speak

読み上げるテキスト。

speak?: string

プロパティ値

string

suggestedActions

アクティビティに対して推奨されるアクション。

suggestedActions?: SuggestedActions

プロパティ値

SuggestedActions

summary

チャネルでカードをレンダリングできない場合に表示するテキスト。

summary?: string

プロパティ値

string

text

メッセージのテキスト コンテンツ。

text: string

プロパティ値

string

textFormat

テキスト フィールドの形式 Default:markdown。 指定できる値は、'markdown'、'plain'、'xml' です。

textFormat?: TextFormatTypes | string

プロパティ値

TextFormatTypes | string

value

アクティビティに関連付けられている値。

value?: any

プロパティ値

any

継承されたプロパティの詳細

channelData

チャネル固有のコンテンツが含まれます。

channelData?: any

プロパティ値

any

IActivity.channelData から継承

channelId

チャネルを一意に識別する ID を含みます。 チャネルによって設定されます。

channelId: string

プロパティ値

string

IActivity.channelId から継承

conversation

アクティビティが属する会話を識別します。

conversation: ConversationAccount

プロパティ値

ConversationAccount

IActivity.conversation から継承された

entities

メッセージに記載されたエンティティを表します。

entities?: Entity[]

プロパティ値

Entity[]

IActivity.entities から継承

from

メッセージの送信者を識別します。

from: ChannelAccount

プロパティ値

ChannelAccount

IActivity から継承.from

id

チャネルのアクティビティを一意に識別する ID を含みます。

id?: string

プロパティ値

string

IActivity.id から継承された

localTimestamp

ISO-8601 形式で表される、メッセージのローカルの日付と時刻を格納します。 たとえば、2016-09-23T13:07:49.4714686-07:00 などです。

localTimestamp?: Date

プロパティ値

Date

IActivity.localTimestamp から継承

recipient

メッセージの受信者を識別します。

recipient: ChannelAccount

プロパティ値

ChannelAccount

IActivity.recipient から継承

replyToId

このメッセージが応答であるメッセージの ID を格納します。

replyToId?: string

プロパティ値

string

IActivity.replyToIdから継承された

serviceUrl

チャネルのサービス エンドポイントを指定する URL が含まれています。 チャネルによって設定されます。

serviceUrl: string

プロパティ値

string

IActivity.serviceUrl から継承

timestamp

ISO-8601 形式で表された、メッセージが送信された日時 (UTC) を格納します。

timestamp?: Date

プロパティ値

Date

IActivity.timestamp から継承

type

アクティビティの種類 'iActivity' が含まれています

type: ActivityTypes | string

プロパティ値

ActivityTypes | string

IActivity.type から継承