IMessage interface
ユーザーとボットの間で送信されるチャット メッセージ。 ボットからユーザーへのメッセージには、次の 2 種類があります。
- リアクティブ メッセージ は、ユーザーからの受信メッセージへの応答としてボットからユーザーに送信されるメッセージです。
- プロアクティブ メッセージ は、アラームトリガーなどの外部イベントに応答してボットからユーザーに送信されるメッセージです。
事後対応型の場合は、受信メッセージから送信メッセージに アドレス フィールドをコピーし (Message ビルダー クラスを使用し、セッションで初期化 自動的に行われる場合)、テキスト または添付ファイル を設定する必要があります。 プロアクティブ メッセージの場合は、受信メッセージから外部ストレージに
受信アドレス オブジェクトを使用してユーザーにメッセージを作成すると、既定では、現在の会話のコンテキストでユーザーに返信が送信されます。 一部のチャネルでは、ユーザーとの新しい会話を開始できます。 ユーザーとの新しいプロアクティブな会話を開始するには、送信メッセージを作成する前に、アドレス オブジェクトから conversation フィールドを削除するだけです。
- Extends
プロパティ
| address | イベントのアドレス ルーティング情報。 このフィールドを外部ストレージに保存して、後でユーザーにプロアクティブ メッセージを作成します。 |
| agent | イベントを処理している SDK。 常に 'botbuilder' になります。 |
| attachment |
クライアントが複数の添付ファイルをレイアウトする方法のヒント。 既定値は 'list' です。 |
| attachments | 受信メッセージには、ユーザーから送信された画像などの添付ファイルが含まれています。 送信メッセージには、ユーザーに送信するカードや画像などのオブジェクトが含まれます。 |
| code | 会話が終了した理由を示すコード。 |
| delivery |
アクティビティの受信者の代替配信パスに通知する配信ヒント。 既定の配信モードは "default" です。 |
| entities | ボットまたはユーザーに渡される構造化オブジェクト。 |
| expriation | アクティビティが "期限切れ" と見なされ、受信者に表示されない時刻。 |
| importance | アクティビティの重要性。 |
| input |
ボットがさらなる入力を期待しているかどうかをクライアントに知らせるヒント。 組み込みのプロンプトでは、送信メッセージに対してこの値が自動的に設定されます。 |
| label | アクティビティの説明ラベル。 |
| listen |
音声および言語プライミング システムがリッスンする必要がある語句と参照の一覧。 |
| local |
メッセージが送信されたローカル時刻 (クライアントまたはボットによって設定されます。例: 2016-09-23T13:07:49.4714686-07:00)。 |
| local |
メッセージが IANA タイム ゾーン データベース形式で表されるタイムゾーンの名前をローカル時刻で格納します。 たとえば、アメリカ/Los_Angelesです。 |
| name | 呼び出す操作の名前またはイベントの名前。 |
| relates |
別の会話またはメッセージへの参照。 |
| reply |
この更新プログラムが関連するイベントの ID。 |
| semantic |
この要求に付随するオプションのプログラムによるアクション。 |
| source | イベントの元のソース ("facebook"、"skype"、"slack" など) |
| source |
ソースネイティブ スキーマの元のイベント。 送信メッセージの場合は、カスタム添付ファイルなどのソース固有のイベント データを渡すために使用できます。 |
| speak | 音声合成マークアップ言語 |
| summary | 最近の会話の一覧など、メッセージコンテンツのフォールバックおよび簡単な説明として表示されるテキスト。 |
| text | メッセージ テキスト。 |
| text |
テキスト フィールドの形式。 既定値は 'markdown' です。 |
| text |
アクティビティに ReplyToId 値が含まれているときに強調表示するテキスト フラグメントのコレクション。 |
| text |
メッセージ テキストの識別された言語 (既知の場合)。 |
| timestamp | メッセージが送信された UTC 時刻 (サービスによって設定)。 |
| type | イベントの種類を定義します。 IMessage の場合は "message" にする必要があります。 |
| user | 受信メッセージの場合、これはメッセージを送信したユーザーです。 既定では、これは address.user のコピーですが、受信ユーザーを内部ユーザー ID にマップできる lookupUser 関数を使用してボットを構成できます。 |
| value | 未終了の値。 |
| value |
アクティビティの値オブジェクトの型。 |
プロパティの詳細
address
イベントのアドレス ルーティング情報。 このフィールドを外部ストレージに保存して、後でユーザーにプロアクティブ メッセージを作成します。
address: IAddressプロパティ値
agent
イベントを処理している SDK。 常に 'botbuilder' になります。
agent: stringプロパティ値
string
attachmentLayout
クライアントが複数の添付ファイルをレイアウトする方法のヒント。 既定値は 'list' です。
attachmentLayout?: stringプロパティ値
string
attachments
受信メッセージには、ユーザーから送信された画像などの添付ファイルが含まれています。 送信メッセージには、ユーザーに送信するカードや画像などのオブジェクトが含まれます。
attachments?: IAttachment[]プロパティ値
code
会話が終了した理由を示すコード。
code?: stringプロパティ値
string
deliveryMode
アクティビティの受信者の代替配信パスに通知する配信ヒント。 既定の配信モードは "default" です。
deliveryMode?: stringプロパティ値
string
entities
ボットまたはユーザーに渡される構造化オブジェクト。
entities?: any[]プロパティ値
any[]
expriation
アクティビティが "期限切れ" と見なされ、受信者に表示されない時刻。
expriation?: stringプロパティ値
string
importance
アクティビティの重要性。
importance?: stringプロパティ値
string
inputHint
ボットがさらなる入力を期待しているかどうかをクライアントに知らせるヒント。 組み込みのプロンプトでは、送信メッセージに対してこの値が自動的に設定されます。
inputHint?: stringプロパティ値
string
label
アクティビティの説明ラベル。
label?: stringプロパティ値
string
listenFor
音声および言語プライミング システムがリッスンする必要がある語句と参照の一覧。
listenFor?: string[]プロパティ値
string[]
localTimestamp
メッセージが送信されたローカル時刻 (クライアントまたはボットによって設定されます。例: 2016-09-23T13:07:49.4714686-07:00)。
localTimestamp?: stringプロパティ値
string
localTimezone
メッセージが IANA タイム ゾーン データベース形式で表されるタイムゾーンの名前をローカル時刻で格納します。 たとえば、アメリカ/Los_Angelesです。
localTimezone?: stringプロパティ値
string
name
呼び出す操作の名前またはイベントの名前。
name?: stringプロパティ値
string
relatesTo
replyToId
この更新プログラムが関連するイベントの ID。
replyToId?: stringプロパティ値
string
semanticAction
source
イベントの元のソース ("facebook"、"skype"、"slack" など)
source: stringプロパティ値
string
sourceEvent
ソースネイティブ スキーマの元のイベント。 送信メッセージの場合は、カスタム添付ファイルなどのソース固有のイベント データを渡すために使用できます。
sourceEvent: anyプロパティ値
any
speak
音声合成マークアップ言語
speak?: stringプロパティ値
string
summary
最近の会話の一覧など、メッセージコンテンツのフォールバックおよび簡単な説明として表示されるテキスト。
summary?: stringプロパティ値
string
text
メッセージ テキスト。
text?: stringプロパティ値
string
textFormat
テキスト フィールドの形式。 既定値は 'markdown' です。
textFormat?: stringプロパティ値
string
textHighlights
アクティビティに ReplyToId 値が含まれているときに強調表示するテキスト フラグメントのコレクション。
textHighlights?: ITextHighlight[]プロパティ値
textLocale
メッセージ テキストの識別された言語 (既知の場合)。
textLocale?: stringプロパティ値
string
timestamp
メッセージが送信された UTC 時刻 (サービスによって設定)。
timestamp?: stringプロパティ値
string
type
イベントの種類を定義します。 IMessage の場合は "message" にする必要があります。
type: stringプロパティ値
string
user
受信メッセージの場合、これはメッセージを送信したユーザーです。 既定では、これは address.user のコピーですが、受信ユーザーを内部ユーザー ID にマップできる lookupUser 関数を使用してボットを構成できます。
user: IIdentityプロパティ値
value
未終了の値。
value?: anyプロパティ値
any
valueType
アクティビティの値オブジェクトの型。
valueType?: stringプロパティ値
string