CallSession class

パッケージ:

botbuilder-calling

ユーザーとのボットの会話を管理します。

コンストラクター

CallSession(ICallSessionOptions)

セッションのインスタンスを作成します。

プロパティ

conversationData	会話のすべてのメンバーに表示される共有会話データ。
dialogData	現在のダイアログにのみ表示されるデータ。
library	ダイアログのボット ルート ライブラリ。
message	ユーザーから受信したメッセージ。 ボットから送信されたメッセージの場合、これは "from" フィールド & "to" フィールドのみを含む場合があります。
privateConversationData	ユーザーにのみ表示されるプライベートな会話データ。
sessionState	現在の状態情報をセッションします。
userData	ボットとのすべての会話で保持されるユーザーのデータ。

メソッド

answer()	呼び出しに手動で応答します。 ボットがアクションを実行すると、呼び出しに自動的に応答します。
beginDialog<T>(string, T)	会話の制御を新しいダイアログに渡します。 現在のダイアログは、子ダイアログが完了するまで中断されます。 子が終了すると、現在のダイアログは、dialogResumed() の呼び出しを受け取り、子から返された結果を検査できます。
dispatch(ISessionState, IEvent)	処理用のメッセージをディスパッチします。 セッションは、処理のためにアクティブなダイアログにメッセージを送信する前に、インストールされているミドルウェアを呼び出します。
endConversation(string | string[] | IAction | IIsAction, any[])	現在の会話を終了し、必要に応じてユーザーにメッセージを送信します。 呼び出しは自動的にハングアップまたは拒否されます。
endDialog(string | string[] | IAction | IIsAction, any[])	現在のダイアログを終了し、必要に応じてユーザーにメッセージを送信します。 親は、IDialogResult.resumed 完了した 理由で再開されます。
endDialogWithResult(IDialogResult<any>)	現在のダイアログを終了し、必要に応じてダイアログの親に結果を返します。
error(Error)	エラーが発生したことを通知します。 ボットは on('error', err) イベントを介してエラーを通知します。
gettext(string, any[])	メッセージ言語のローカライズされた文字列を読み込みます。 引数が渡された場合、ローカライズされた文字列はテンプレートとして扱われ、sprintf-js を使用して書式設定されます (詳細については、ドキュメントを参照してください)。
hangup()	確立された呼び出しを手動で終了します。 ボットがユーザーに入力を求めるメッセージを停止すると、呼び出しは自動的に終了します。
isReset()	セッションがリセットされた場合は true を返します。
messageSent()	このセッションに対してメッセージが送信された場合は true を返します。
ngettext(string, string, number)	メッセージ言語のローカライズされた文字列の複数形を読み込みます。 出力文字列は、文字列内の %d をカウントに置き換えることで、カウントを含むように書式設定されます。
on(string, Function)	イベント リスナーを登録します。
reject()	着信通話を拒否します。
replaceDialog<T>(string, T)	現在のダイアログを終了し、新しいダイアログを開始します。 親ダイアログは、新しいダイアログが完了するまで再開されません。
reset(string, any)	セッションの呼び出し履歴をクリアし、構成された dialogId を使用して会話を再開します。
save()	dialogData、userData 、conversationdata、または [privateConversationData'(#privateconversationdata) に加えられた変更の保存をトリガーします。
send(string | string[] | IAction | IIsAction, any[])	PlayPrompt アクションをユーザーに送信します。
sendBatch()	現在のバッチを直ちに終了し、キューに登録されたメッセージを配信します。

コンストラクターの詳細

CallSession(ICallSessionOptions)

セッションのインスタンスを作成します。

new CallSession(options: ICallSessionOptions)

パラメーター

options

ICallSessionOptions

セッション構成オプション。

プロパティの詳細

conversationData

会話のすべてのメンバーに表示される共有会話データ。

conversationData: any

プロパティ値

any

dialogData

現在のダイアログにのみ表示されるデータ。

dialogData: any

プロパティ値

any

library

ダイアログのボット ルート ライブラリ。

library: Library

プロパティ値

Library

message

ユーザーから受信したメッセージ。 ボットから送信されたメッセージの場合、これは "from" フィールド & "to" フィールドのみを含む場合があります。

message: IEvent

プロパティ値

IEvent

privateConversationData

ユーザーにのみ表示されるプライベートな会話データ。

privateConversationData: any

プロパティ値

any

sessionState

現在の状態情報をセッションします。

sessionState: ISessionState

プロパティ値

ISessionState

userData

ボットとのすべての会話で保持されるユーザーのデータ。

userData: any

プロパティ値

any

メソッドの詳細

answer()

呼び出しに手動で応答します。 ボットがアクションを実行すると、呼び出しに自動的に応答します。

function answer()

戻り値

CallSession

beginDialog<T>(string, T)

会話の制御を新しいダイアログに渡します。 現在のダイアログは、子ダイアログが完了するまで中断されます。 子が終了すると、現在のダイアログは、dialogResumed() の呼び出しを受け取り、子から返された結果を検査できます。

function beginDialog<T>(id: string, args?: T)

パラメーター

id

string

開始するダイアログの一意の ID。

args

T

(省略可能) begin() メソッド ダイアログに渡す引数。

戻り値

CallSession

dispatch(ISessionState, IEvent)

処理用のメッセージをディスパッチします。 セッションは、処理のためにアクティブなダイアログにメッセージを送信する前に、インストールされているミドルウェアを呼び出します。

function dispatch(sessionState: ISessionState, message: IEvent)

パラメーター

sessionState

ISessionState

現在のセッションの状態。 null 場合は、構成された dialogIdから新しい会話が開始されます。

message

IEvent

ディスパッチするメッセージ。

戻り値

CallSession

endConversation(string | string[] | IAction | IIsAction, any[])

現在の会話を終了し、必要に応じてユーザーにメッセージを送信します。 呼び出しは自動的にハングアップまたは拒否されます。

function endConversation(action?: string | string[] | IAction | IIsAction, args: any[])

パラメーター

action

string | string[] | IAction | IIsAction

(省略可能)

• アクション:{string} - 送信するメッセージのテキスト。 メッセージは、構成されたローカライザーのセッションを使用してローカライズされます。 メッセージに引数が渡された場合は、sprintf-js 使用して書式設定されます。
• アクション:{string[]} - 送信されたメッセージは配列からランダムに選択されます。
• アクション: {IAction|IIsAction} - 送信するアクション。

args

any[]

(省略可能) メッセージ が {string|string[]} である場合 最終的な出力テキストの書式設定に使用される引数。

戻り値

CallSession

endDialog(string | string[] | IAction | IIsAction, any[])

現在のダイアログを終了し、必要に応じてユーザーにメッセージを送信します。 親は、IDialogResult.resumed 完了した 理由で再開されます。

function endDialog(action?: string | string[] | IAction | IIsAction, args: any[])

パラメーター

action

string | string[] | IAction | IIsAction

(省略可能)

• アクション:{string} - 送信するメッセージのテキスト。 メッセージは、構成されたローカライザーのセッションを使用してローカライズされます。 メッセージに引数が渡された場合は、sprintf-js 使用して書式設定されます。
• アクション:{string[]} - 送信されたメッセージは配列からランダムに選択されます。
• アクション: {IAction|IIsAction} - 送信するアクション。

args

any[]

(省略可能) メッセージ が {string|string[]} である場合 最終的な出力テキストの書式設定に使用される引数。

戻り値

CallSession

endDialogWithResult(IDialogResult<any>)

現在のダイアログを終了し、必要に応じてダイアログの親に結果を返します。

function endDialogWithResult(result?: IDialogResult<any>)

パラメーター

result

IDialogResult<any>

戻り値

CallSession

error(Error)

エラーが発生したことを通知します。 ボットは on('error', err) イベントを介してエラーを通知します。

function error(err: Error)

パラメーター

err

Error

発生したエラー。

戻り値

CallSession

gettext(string, any[])

メッセージ言語のローカライズされた文字列を読み込みます。 引数が渡された場合、ローカライズされた文字列はテンプレートとして扱われ、sprintf-js を使用して書式設定されます (詳細については、ドキュメントを参照してください)。

function gettext(msgid: string, args: any[])

パラメーター

msgid

string

ローカライズされた文字列テーブルのキーとして使用する文字列。 通常、これは文字列の英語版になります。

args

any[]

(省略可能) 最終的な出力文字列の書式設定に使用される引数。

戻り値

string

hangup()

確立された呼び出しを手動で終了します。 ボットがユーザーに入力を求めるメッセージを停止すると、呼び出しは自動的に終了します。

function hangup()

戻り値

CallSession

isReset()

セッションがリセットされた場合は true を返します。

function isReset()

戻り値

boolean

messageSent()

このセッションに対してメッセージが送信された場合は true を返します。

function messageSent()

戻り値

boolean

ngettext(string, string, number)

メッセージ言語のローカライズされた文字列の複数形を読み込みます。 出力文字列は、文字列内の %d をカウントに置き換えることで、カウントを含むように書式設定されます。

function ngettext(msgid: string, msgid_plural: string, count: number)

パラメーター

msgid

string

ローカライズされた文字列テーブルのキーとして使用する文字列の単数形。 %d を使用して、カウントの移動先を指定します。

msgid_plural

string

ローカライズされた文字列テーブルのキーとして使用する文字列の複数形。 %d を使用して、カウントの移動先を指定します。

count

number

文字列の単数形または複数形のどちらを使用するかを決定するときに使用するカウント。

戻り値

string

on(string, Function)

イベント リスナーを登録します。

function on(event: string, listener: Function)

パラメーター

event

string

イベントの名前。 イベントの種類:

• エラー: エラーが発生しました。 IErrorEvent の

listener

Function

呼び出す関数。

reject()

着信通話を拒否します。

function reject()

戻り値

CallSession

replaceDialog<T>(string, T)

現在のダイアログを終了し、新しいダイアログを開始します。 親ダイアログは、新しいダイアログが完了するまで再開されません。

function replaceDialog<T>(id: string, args?: T)

パラメーター

id

string

開始するダイアログの一意の ID。

args

T

(省略可能) begin() メソッド ダイアログに渡す引数。

戻り値

CallSession

reset(string, any)

セッションの呼び出し履歴をクリアし、構成された dialogId を使用して会話を再開します。

function reset(dialogId?: string, dialogArgs?: any)

パラメーター

dialogId

string

(省略可能)開始するダイアログの ID。

dialogArgs

any

(省略可能) begin() メソッド ダイアログに渡す引数。

戻り値

CallSession

save()

dialogData、userData 、conversationdata、または [privateConversationData'(#privateconversationdata) に加えられた変更の保存をトリガーします。

function save()

戻り値

CallSession

send(string | string[] | IAction | IIsAction, any[])

PlayPrompt アクションをユーザーに送信します。

function send(action: string | string[] | IAction | IIsAction, args: any[])

パラメーター

action

string | string[] | IAction | IIsAction

• アクション:{string} - 送信するメッセージのテキスト。 メッセージは、構成されたローカライザーのセッションを使用してローカライズされます。 メッセージに引数が渡された場合は、sprintf-js 使用して書式設定されます。
• アクション:{string[]} - 送信されたメッセージは配列からランダムに選択されます。
• アクション: {IAction|IIsAction} - 送信するアクション。

args

any[]

(省略可能) アクション が {string|string[]} である場合 最終的な出力テキストの書式設定に使用される引数。

戻り値

CallSession

sendBatch()

現在のバッチを直ちに終了し、キューに登録されたメッセージを配信します。

function sendBatch()