UniversalCallBot class
複数のチャネルにわたるユーザーとのボットの会話を管理します。
コンストラクター
| Universal |
UniversalCallBot の新しいインスタンスを作成します。 |
メソッド
| dialog(string, Dialog | IDialog |
ボットのダイアログを登録または返します。 |
| get(string) | 設定の現在の値を返します。 |
| library(Library | string) | ライブラリの依存関係を登録または返します。 |
| on(string, Function) | イベント リスナーを登録します。 |
| set(string, any) | ボットの設定を設定します。 |
| use(IMiddleware |
ボットのミドルウェアをインストールします。 ミドルウェアを使用すると、受信イベントと送信イベント/メッセージをインターセプトできます。 |
コンストラクターの詳細
UniversalCallBot(ICallConnector, IUniversalCallBotSettings)
UniversalCallBot の新しいインスタンスを作成します。
new UniversalCallBot(connector: ICallConnector, settings?: IUniversalCallBotSettings)パラメーター
- connector
- ICallConnector
(省略可能) 要求に使用する既定のコネクタ。 チャネルに登録されているより具体的なコネクタがない場合は、このコネクタが使用されます。/**
- settings
- IUniversalCallBotSettings
(省略可能) ボットを構成するための設定。
メソッドの詳細
dialog(string, Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)
ボットのダイアログを登録または返します。
function dialog(id: string, dialog?: Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)パラメーター
- id
-
string
レジストリサイト化または取得されるダイアログの一意の ID。
- dialog
(省略可能) 登録するダイアログまたはウォーターフォール。
ダイアログ: {Dialog} - 追加するダイアログを します。 -
ダイアログ:{IDialogWaterfallStep[]} - 実行するステップのウォーターフォール。 詳細については、IDialogWaterfallStep の
を参照してください。 - ダイアログ:{IDialogWaterfallStep} - 単一ステップウォーターフォール。 組み込みのプロンプトを呼び出すか、新しいダイアログを開始すると、子プロンプト/ダイアログの完了時に現在のダイアログが終了します。
戻り値
get(string)
設定の現在の値を返します。
function get(name: string)パラメーター
- name
-
string
返すプロパティの名前。 有効な名前は、IUniversalCallBotSettingsのプロパティです。
戻り値
any
library(Library | string)
ライブラリの依存関係を登録または返します。
function library(lib: Library | string)パラメーター
- lib
-
Library | string
- lib:{Library} - 依存関係として登録するライブラリ。
- lib:{string} - 参照するライブラリの一意の名前。 すべての依存関係も検索されます。
戻り値
on(string, Function)
イベント リスナーを登録します。
function on(event: string, listener: Function)パラメーター
- event
-
string
イベントの名前。 イベントの種類:
-
エラー: エラーが発生しました。 IErrorEvent の
- listener
-
Function
呼び出す関数。
set(string, any)
ボットの設定を設定します。
function set(name: string, value: any)パラメーター
- name
-
string
設定するプロパティの名前。 有効な名前は、IUniversalCallBotSettingsのプロパティです。
- value
-
any
設定に割り当てる値。
戻り値
use(IMiddlewareMap[])
ボットのミドルウェアをインストールします。 ミドルウェアを使用すると、受信イベントと送信イベント/メッセージをインターセプトできます。
function use(args: IMiddlewareMap[])パラメーター
- args
インストールするミドルウェア フックの 1 つ以上のセット。