Message class

パッケージ:

botbuilder

添付ファイルを含む複雑なメッセージの作成を簡略化するメッセージ ビルダー クラス。

コンストラクター

Message(Session)

新しいメッセージ ビルダーを作成します。

メソッド

addAttachment(AttachmentType)	メッセージに添付ファイルを追加します。 例については、IAttachment の を参照してください。
addEntity(Object)	メッセージにエンティティを追加します。
address(IAddress)	メッセージのアドレス ルーティング情報。 このフィールドを外部ストレージに保存して、後でユーザーにプロアクティブ メッセージを作成します。
attachmentLayout(string)	クライアントが複数の添付ファイルをレイアウトする方法のヒント。 既定値は 'list' です。
attachments(AttachmentType[])	ユーザーに送信するカードまたは画像。
code(string)	会話が終了した理由を示すコード。
compose(string[][], any[])	ユーザーに対する複雑でランダム化された応答を作成します。
composePrompt(Session, string[][], any[])	非推奨 代わりに compose() を使用してください。
composePrompt(Session, string[][], any[])	プロンプトの配列を 1 つのローカライズされたプロンプトに結合し、必要に応じて、渡された引数でプロンプト テンプレート スロットに入力します。
entities(Object[])	ボットまたはユーザーに渡される構造化オブジェクト。
inputHint(string)	ボットがさらなる入力を期待しているかどうかをクライアントに知らせるヒント。 組み込みのプロンプトでは、送信メッセージに対してこの値が自動的に設定されます。
localTimestamp(string)	メッセージが送信されたローカル時刻 (クライアントまたはボットによって設定されます。例: 2016-09-23T13:07:49.4714686-07:00)。
name(string)	呼び出す操作の名前またはイベントの名前。
nspeak(TextType, TextType, number)	指定した数のメッセージの読み上げフィールドを条件付きで設定します。
ntext(TextType, TextType, number)	指定した数のメッセージ テキストを条件付きで設定します。
originalEvent(any)	受信メッセージのチャネルの元またはネイティブ形式のメッセージ。
randomPrompt(TextType)	プロンプトをランダムに選択します。
relatesTo(IAddress)	別の会話またはメッセージへの参照。
setChannelData(any)	非推奨 、代わりに sourceEvent() 使用。
setLanguage(string)	非推奨 代わりに local() 使用してください。
setNText(Session, string, string, number)	非推奨 代わりに ntext() 使用してください。
setText(Session, TextType, any[])	非推奨 、代わりに text() 使用。
sourceEvent(ISourceEventMap)	送信メッセージの場合は、カスタム添付ファイルなどのソース固有のイベント データを渡すために使用できます。
speak(TextType, any[])	メッセージの読み上げフィールドを音声合成マークアップ言語 (SSML)設定します。 これは、サポートされているデバイス上のユーザーに読み上げされます。
suggestedActions(ISuggestedActions | IIsSuggestedActions)	ユーザーに送信するオプションの推奨アクション。 推奨されるアクションは、推奨されるアクションをサポートするチャネルにのみ表示されます。
summary(TextType, any[])	最近の会話の一覧など、メッセージコンテンツのフォールバックおよび簡単な説明として表示されるテキスト。
text(TextType, any[])	メッセージ テキストを設定します。
textFormat(string)	テキスト フィールドの形式。
textLocale(string)	メッセージの言語。
timestamp(string)	コネクタ サービスによって設定されます。 代わりに localTimestamp() 使用してください。
toMessage()	メッセージの JSON を返します。
value(any)	未終了の値。

コンストラクターの詳細

Message(Session)

新しいメッセージ ビルダーを作成します。

new Message(session?: Session)

パラメーター

session

Session

(省略可能) は、メッセージ アドレスを設定し、テキストをローカライズするために使用されます。

メソッドの詳細

addAttachment(AttachmentType)

メッセージに添付ファイルを追加します。 例については、IAttachment の を参照してください。

function addAttachment(attachment: AttachmentType)

パラメーター

attachment

AttachmentType

追加する添付ファイル。

戻り値

Message

addEntity(Object)

メッセージにエンティティを追加します。

function addEntity(obj: Object)

パラメーター

obj

Object

戻り値

Message

address(IAddress)

メッセージのアドレス ルーティング情報。 このフィールドを外部ストレージに保存して、後でユーザーにプロアクティブ メッセージを作成します。

function address(adr: IAddress)

パラメーター

adr

IAddress

戻り値

Message

attachmentLayout(string)

クライアントが複数の添付ファイルをレイアウトする方法のヒント。 既定値は 'list' です。

function attachmentLayout(style: string)

パラメーター

style

string

戻り値

Message

attachments(AttachmentType[])

ユーザーに送信するカードまたは画像。

function attachments(list: AttachmentType[])

パラメーター

list

AttachmentType[]

戻り値

Message

code(string)

会話が終了した理由を示すコード。

function code(value: string)

パラメーター

value

string

戻り値

Message

compose(string[][], any[])

ユーザーに対する複雑でランダム化された応答を作成します。

function compose(prompts: string[][], args: any[])

パラメーター

prompts

string[][]

args

any[]

戻り値

Message

composePrompt(Session, string[][], any[])

非推奨 代わりに compose() を使用してください。

function composePrompt(session: Session, prompts: string[][], args: any[])

パラメーター

session

Session

prompts

string[][]

args

any[]

戻り値

Message

composePrompt(Session, string[][], any[])

プロンプトの配列を 1 つのローカライズされたプロンプトに結合し、必要に応じて、渡された引数でプロンプト テンプレート スロットに入力します。

static function composePrompt(session: Session, prompts: string[][], args?: any[])

パラメーター

session

Session

個々のプロンプト 部分をローカライズするために使用されるセッション オブジェクト。

prompts

string[][]

プロンプト リストの配列。 配列内の各エントリは、ランダムに選択されるプロンプトの別の配列です。 結合された出力テキストはスペース区切りになります。

args

any[]

(省略可能) プロンプトがテンプレートの場合に出力テキストの書式設定に使用される引数の配列。

戻り値

string

entities(Object[])

ボットまたはユーザーに渡される構造化オブジェクト。

function entities(list: Object[])

パラメーター

list

Object[]

戻り値

Message

inputHint(string)

ボットがさらなる入力を期待しているかどうかをクライアントに知らせるヒント。 組み込みのプロンプトでは、送信メッセージに対してこの値が自動的に設定されます。

function inputHint(hint: string)

パラメーター

hint

string

戻り値

Message

localTimestamp(string)

メッセージが送信されたローカル時刻 (クライアントまたはボットによって設定されます。例: 2016-09-23T13:07:49.4714686-07:00)。

function localTimestamp(time?: string)

パラメーター

time

string

(省略可能) ISO 文字列として表される時刻。 既定値は new Date().toISOString()です。

戻り値

Message

name(string)

呼び出す操作の名前またはイベントの名前。

function name(name: string)

パラメーター

name

string

戻り値

Message

nspeak(TextType, TextType, number)

指定した数のメッセージの読み上げフィールドを条件付きで設定します。

function nspeak(ssml: TextType, ssml_plural: TextType, count: number)

パラメーター

ssml

TextType

ssml_plural

TextType

count

number

戻り値

Message

ntext(TextType, TextType, number)

指定した数のメッセージ テキストを条件付きで設定します。

function ntext(msg: TextType, msg_plural: TextType, count: number)

パラメーター

msg

TextType

msg_plural

TextType

count

number

戻り値

Message

originalEvent(any)

受信メッセージのチャネルの元またはネイティブ形式のメッセージ。

function originalEvent(event: any)

パラメーター

event

any

戻り値

Message

randomPrompt(TextType)

プロンプトをランダムに選択します。

static function randomPrompt(prompts: TextType)

パラメーター

prompts

TextType

選択するプロンプトの配列。 プロンプトが文字列 型 場合、プロンプトは単に変更されていない状態で返されます。

戻り値

string

relatesTo(IAddress)

別の会話またはメッセージへの参照。

function relatesTo(adr: IAddress)

パラメーター

adr

IAddress

戻り値

Message

setChannelData(any)

非推奨 、代わりに sourceEvent() 使用。

function setChannelData(data: any)

パラメーター

data

any

戻り値

Message

setLanguage(string)

非推奨 代わりに local() 使用してください。

function setLanguage(language: string)

パラメーター

language

string

戻り値

Message

setNText(Session, string, string, number)

非推奨 代わりに ntext() 使用してください。

function setNText(session: Session, msg: string, msg_plural: string, count: number)

パラメーター

session

Session

msg

string

msg_plural

string

count

number

戻り値

Message

setText(Session, TextType, any[])

非推奨 、代わりに text() 使用。

function setText(session: Session, prompt: TextType, args: any[])

パラメーター

session

Session

prompt

TextType

args

any[]

戻り値

Message

sourceEvent(ISourceEventMap)

送信メッセージの場合は、カスタム添付ファイルなどのソース固有のイベント データを渡すために使用できます。

function sourceEvent(map: ISourceEventMap)

パラメーター

map

ISourceEventMap

戻り値

Message

speak(TextType, any[])

メッセージの読み上げフィールドを音声合成マークアップ言語 (SSML)設定します。 これは、サポートされているデバイス上のユーザーに読み上げされます。

function speak(ssml: TextType, args: any[])

パラメーター

ssml

TextType

args

any[]

戻り値

Message

suggestedActions(ISuggestedActions | IIsSuggestedActions)

ユーザーに送信するオプションの推奨アクション。 推奨されるアクションは、推奨されるアクションをサポートするチャネルにのみ表示されます。

function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)

パラメーター

suggestedActions

ISuggestedActions | IIsSuggestedActions

戻り値

Message

summary(TextType, any[])

最近の会話の一覧など、メッセージコンテンツのフォールバックおよび簡単な説明として表示されるテキスト。

function summary(text: TextType, args: any[])

パラメーター

text

TextType

args

any[]

戻り値

Message

text(TextType, any[])

メッセージ テキストを設定します。

function text(text: TextType, args: any[])

パラメーター

text

TextType

args

any[]

戻り値

Message

textFormat(string)

テキスト フィールドの形式。

function textFormat(style: string)

パラメーター

style

string

戻り値

Message

textLocale(string)

メッセージの言語。

function textLocale(locale: string)

パラメーター

locale

string

戻り値

Message

timestamp(string)

コネクタ サービスによって設定されます。 代わりに localTimestamp() 使用してください。

function timestamp(time?: string)

パラメーター

time

string

戻り値

Message

toMessage()

メッセージの JSON を返します。

function toMessage()

戻り値

IMessage

value(any)

未終了の値。

function value(param: any)

パラメーター

param

any

戻り値

Message