Library class
ルーティング目的で使用される関連ダイアログのライブラリ。 ライブラリを連結して、複雑なボットの開発を可能にすることができます。
UniversalCallBot クラス自体は、このチェーンのルートを形成するライブラリです。
再利用可能なパーツのライブラリは、ボットと同様に新しいライブラリ インスタンスを作成し、ダイアログを追加することで開発できます。 ライブラリには、ライブラリ Web サイトまたは NPM モジュール名に対応する一意の名前が必要です。 その後、UniversalCallBot.library()を使用して、パーツ ライブラリ インスタンス
ライブラリ ボット内でダイアログを呼び出すには、session.beginDialog() を ':' の形式で完全修飾ダイアログ ID で呼び出す必要があります。 通常は、ダイアログを開始するモジュールから関数を公開することで、devloper からこれを非表示にします。
したがって、myLib.someDialog(session, { arg: '' }); のようなものを呼び出すと、内部で session.beginDialog('myLib:someDialog', args); を呼び出すことになります。
ダイアログは常に現在のダイアログ内で呼び出されるため、ライブラリからのダイアログ内で、すべての beginDialog() がライブラリ名で呼び出す前にプレフィックスを付ける必要はありません。 ライブラリ名プレフィックスを含める必要があるのは、あるライブラリ コンテキストから別のライブラリ コンテキストに交差する場合のみです。
コンストラクター
| Library(string) | ライブラリの新しいインスタンスを作成します。 |
プロパティ
| name | ライブラリの一意の名前。 |
メソッド
| dialog(string, Dialog | IDialog |
ライブラリからダイアログを登録または返します。 |
| find |
ライブラリとそのすべての依存関係で特定のダイアログを検索します。 見つかった場合はダイアログを返し、それ以外の場合は null を返します。 |
| library(Library | string) | ライブラリの依存関係を登録または返します。 |
コンストラクターの詳細
Library(string)
ライブラリの新しいインスタンスを作成します。
new Library(name: string)パラメーター
- name
-
string
プロパティの詳細
name
ライブラリの一意の名前。
name: stringプロパティ値
string
メソッドの詳細
dialog(string, Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)
ライブラリからダイアログを登録または返します。
function dialog(id: string, dialog?: Dialog | IDialogWaterfallStep[] | IDialogWaterfallStep)パラメーター
- id
-
string
レジストリサイト化または取得されるダイアログの一意の ID。
- dialog
(省略可能) 登録するダイアログまたはウォーターフォール。
ダイアログ: {Dialog} - 追加するダイアログを します。 -
ダイアログ:{IDialogWaterfallStep[]} - 実行するステップのウォーターフォール。 詳細については、IDialogWaterfallStep の
を参照してください。 - ダイアログ:{IDialogWaterfallStep} - 単一ステップウォーターフォール。 組み込みのプロンプトを呼び出すか、新しいダイアログを開始すると、子プロンプト/ダイアログの完了時に現在のダイアログが終了します。
戻り値
findDialog(string, string)
ライブラリとそのすべての依存関係で特定のダイアログを検索します。 見つかった場合はダイアログを返し、それ以外の場合は null を返します。
function findDialog(libName: string, dialogId: string)パラメーター
- libName
-
string
ダイアログを含むライブラリの名前。
- dialogId
-
string
ライブラリ内のダイアログの一意の ID。