Activity interface

パッケージ:

botframework-schema

アクティビティは、Bot Framework 3.0 プロトコルの基本的な通信の種類です。

プロパティ

action	contactRelationUpdate の受信者が送信者の連絡先リストに追加されたか削除されたかを示します。
attachmentLayout	複数の添付ファイルのレイアウト ヒント。 既定値: リスト。 使用可能な値は、'list'、'カルーセル' です。
attachments	[Attachments]
callerId	ボットの呼び出し元を識別する URI を含む文字列。 このフィールドは、ネットワーク経由で送信されるものではありません。その代わりに、呼び出し元 (トークンなど) の ID をアサートする暗号的に検証可能なデータに基づいて、ボットとクライアントによって設定されます。
channelData	チャネル固有のコンテンツが含まれます。
channelId	チャネルを一意に識別する ID を含みます。 チャネルによって設定されます。
code	会話が終了した理由を示す endOfConversation アクティビティのコード。 指定できる値は、'unknown'、'completedSuccessfully'、'userCancelled'、'botTimedOut'、'botIssuedInvalidMessage'、'channelFailed' です。
conversation	アクティビティが属する会話を識別します。
deliveryMode	アクティビティの受信者の代替配信パスに通知する配信ヒント。 既定の配信モードは "default" です。 指定できる値は、'normal'、'notification'、'expectReplies'、'ephemeral' です。
entities	メッセージに記載されたエンティティを表します。
expiration	アクティビティを "期限切れ" と見なす時刻です。これは受信者に表示すべきではありません。
from	メッセージの送信者を識別します。
historyDisclosed	チャネルの以前の履歴が開示されているかどうかを示します。
id	チャネルのアクティビティを一意に識別する ID を格納します。
importance	アクティビティの重要度。 指定できる値は、'low'、'normal'、'high' です。
inputHint	メッセージがクライアントに配信された後、ボットがユーザー入力を受け入れるか、想定しているか、無視しているかを示します。 指定できる値は、'acceptingInput'、'ignoringInput'、'expectingInput' です。
label	アクティビティの説明ラベル。
listenFor	音声および言語プライミング システムがリッスンする必要があるフレーズと参照の一覧
locale	テキスト フィールドの内容のロケール名。 ロケール名は、言語に関連付けられた ISO 639 の 2 文字または 3 文字のカルチャ コードと、国または地域に関連付けられた ISO 3166 2 文字のサブカルチャ コードの組み合わせです。 ロケール名は、有効な BCP-47 言語タグに対応することもできます。
localTimestamp	ISO-8601 形式で表される、メッセージのローカルの日付と時刻を格納します。 たとえば、2016-09-23T13:07:49.4714686-07:00 などです。
localTimezone	IANA タイム ゾーン データベース形式で表される、メッセージのローカル タイムゾーンの名前が格納されます。 例: America/Los_Angeles。
membersAdded	会話に追加されたメンバーのコレクション。
membersRemoved	会話から削除されたメンバーのコレクション。
name	呼び出しまたはイベント アクティビティに関連付けられている操作の名前。
reactionsAdded	会話に追加された反応のコレクション。
reactionsRemoved	会話から削除された反応のコレクション。
recipient	メッセージの受信者を識別します。
relatesTo	別の会話またはアクティビティへの参照。
replyToId	このメッセージが応答であるメッセージの ID を格納します。
semanticAction	この要求に付随するオプションのプログラムによるアクション
serviceUrl	チャネルのサービス エンドポイントを指定する URL を格納します。 チャネルによって設定されます。
speak	読み上げるテキスト。
suggestedActions	アクティビティに推奨されるアクション。
summary	チャネルでカードをレンダリングできない場合に表示するテキスト。
text	メッセージのテキスト コンテンツ。
textFormat	テキスト フィールドの形式 Default:markdown。 指定できる値は、'markdown'、'plain'、'xml' です。
textHighlights	アクティビティに ReplyToId 値が含まれている場合に強調表示するテキスト フラグメントのコレクション。
timestamp	ISO-8601 形式で表された、メッセージが送信された日付と時刻を UTC で格納します。
topicName	スレッドの更新されたトピック名。
type	アクティビティの種類を格納します。 指定できる値は、'message'、'contactRelationUpdate'、'conversationUpdate'、'typing'、'endOfConversation'、'event'、'invoke'、'deleteUserData'、'messageUpdate'、'messageDelete'、'installationUpdate'、'messageReaction'、'suggestion'、'trace'、'handoff' です。
value	アクティビティに関連付けられている値。
valueType	アクティビティの値オブジェクトの型。

プロパティの詳細

action

contactRelationUpdate の受信者が送信者の連絡先リストに追加されたか削除されたかを示します。

action?: string

プロパティ値

string

attachmentLayout

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

attachmentLayout?: AttachmentLayoutTypes | string

プロパティ値

AttachmentLayoutTypes | string

attachments

[Attachments]

attachments?: Attachment[]

プロパティ値

Attachment[]

callerId

ボットの呼び出し元を識別する URI を含む文字列。 このフィールドは、ネットワーク経由で送信されるものではありません。その代わりに、呼び出し元 (トークンなど) の ID をアサートする暗号的に検証可能なデータに基づいて、ボットとクライアントによって設定されます。

callerId: string

プロパティ値

string

channelData

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

channelData?: any

プロパティ値

any

channelId

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

channelId: string

プロパティ値

string

code

会話が終了した理由を示す endOfConversation アクティビティのコード。 指定できる値は、'unknown'、'completedSuccessfully'、'userCancelled'、'botTimedOut'、'botIssuedInvalidMessage'、'channelFailed' です。

code?: EndOfConversationCodes | string

プロパティ値

EndOfConversationCodes | string

conversation

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

conversation: ConversationAccount

プロパティ値

ConversationAccount

deliveryMode

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

deliveryMode?: DeliveryModes | string

プロパティ値

DeliveryModes | string

entities

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

entities?: Entity[]

プロパティ値

Entity[]

expiration

アクティビティを "期限切れ" と見なす時刻です。これは受信者に表示すべきではありません。

expiration?: Date

プロパティ値

Date

from

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

from: ChannelAccount

プロパティ値

ChannelAccount

historyDisclosed

チャネルの以前の履歴が開示されているかどうかを示します。

historyDisclosed?: boolean

プロパティ値

boolean

id

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

id?: string

プロパティ値

string

importance

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

importance?: ActivityImportance | string

プロパティ値

ActivityImportance | string

inputHint

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

inputHint?: InputHints | string

プロパティ値

InputHints | string

label

アクティビティの説明ラベル。

label: string

プロパティ値

string

listenFor

音声および言語プライミング システムがリッスンする必要があるフレーズと参照の一覧

listenFor: string[]

プロパティ値

string[]

locale

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

locale?: string

プロパティ値

string

localTimestamp

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

localTimestamp?: Date

プロパティ値

Date

localTimezone

IANA タイム ゾーン データベース形式で表される、メッセージのローカル タイムゾーンの名前が格納されます。 例: America/Los_Angeles。

localTimezone: string

プロパティ値

string

membersAdded

会話に追加されたメンバーのコレクション。

membersAdded?: ChannelAccount[]

プロパティ値

ChannelAccount[]

membersRemoved

会話から削除されたメンバーのコレクション。

membersRemoved?: ChannelAccount[]

プロパティ値

ChannelAccount[]

name

呼び出しまたはイベント アクティビティに関連付けられている操作の名前。

name?: ActivityEventNames | string

プロパティ値

ActivityEventNames | string

reactionsAdded

会話に追加された反応のコレクション。

reactionsAdded?: MessageReaction[]

プロパティ値

MessageReaction[]

reactionsRemoved

会話から削除された反応のコレクション。

reactionsRemoved?: MessageReaction[]

プロパティ値

MessageReaction[]

recipient

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

recipient: ChannelAccount

プロパティ値

ChannelAccount

relatesTo

別の会話またはアクティビティへの参照。

relatesTo?: ConversationReference

プロパティ値

ConversationReference

replyToId

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

replyToId?: string

プロパティ値

string

semanticAction

この要求に付随するオプションのプログラムによるアクション

semanticAction?: SemanticAction

プロパティ値

SemanticAction

serviceUrl

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

serviceUrl: 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

textHighlights

アクティビティに ReplyToId 値が含まれている場合に強調表示するテキスト フラグメントのコレクション。

textHighlights?: TextHighlight[]

プロパティ値

TextHighlight[]

timestamp

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

timestamp?: Date

プロパティ値

Date

topicName

スレッドの更新されたトピック名。

topicName?: string

プロパティ値

string

type

アクティビティの種類を格納します。 指定できる値は、'message'、'contactRelationUpdate'、'conversationUpdate'、'typing'、'endOfConversation'、'event'、'invoke'、'deleteUserData'、'messageUpdate'、'messageDelete'、'installationUpdate'、'messageReaction'、'suggestion'、'trace'、'handoff' です。

type: ActivityTypes | string

プロパティ値

ActivityTypes | string

value

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

value?: any

プロパティ値

any

valueType

アクティビティの値オブジェクトの型。

valueType: string

プロパティ値

string