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
- 库:{Library} - 要注册为依赖项的库。
- 库:{string} - 要查找的库的唯一名称。 还将搜索所有依赖项。
返回
on(string, Function)
注册事件侦听器。
function on(event: string, listener: Function)
参数
- listener
-
Function
要调用的函数。
set(string, any)
设置机器人上的设置。
function set(name: string, value: any)
参数
- name
-
string
要设置的属性的名称。 有效名称是 IUniversalCallBotSettings的属性。
- value
-
any
要分配给设置的值。
返回
use(IMiddlewareMap[])
为机器人安装中间件。 中间件允许截获传入和传出事件/消息。
function use(args: IMiddlewareMap[])
参数
- args
要安装的一组或多组中间件挂钩。