ConsoleConnector class
通过控制台窗口将 UniversalBot 连接到命令行。
方法
| listen() | 启动侦听 stdIn 的连接器。 |
| on |
在注册时由 UniversalBot 调用,以注册处理程序以接收来自通道的传入事件。 |
| on |
用于注册用于接收传入调用事件的处理程序。 |
| process |
通过连接器发送事件。 |
| process |
通过连接器发送消息。 |
| send(IMessage[], (err: Error, addresses?: IAddress[]) => void) | 由 UniversalBot 调用,以便向用户传递传出消息。 |
| start |
当 UniversalBot 想要与用户启动新的主动对话时调用。 连接器应返回格式正确的 地址 对象,其中填充了 会话 字段。 |
方法详细信息
listen()
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)
在注册时由 UniversalBot 调用,以注册处理程序以接收来自通道的传入事件。
function onEvent(handler: (events: IEvent[], callback?: (err: Error) => void) => void)
参数
- handler
-
(events: IEvent[], callback?: (err: Error) => void) => void
onInvoke((event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)
用于注册用于接收传入调用事件的处理程序。
function onInvoke(handler: (event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)
参数
- handler
-
(event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void
processEvent(IEvent)
processMessage(string)
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)
由 UniversalBot 调用,以便向用户传递传出消息。
function send(messages: IMessage[], callback: (err: Error, addresses?: IAddress[]) => void)
参数
- messages
-
IMessage[]
- callback
-
(err: Error, addresses?: IAddress[]) => void
startConversation(IAddress, (err: Error, address?: IAddress) => void)
当 UniversalBot 想要与用户启动新的主动对话时调用。 连接器应返回格式正确的 地址 对象,其中填充了 会话 字段。
function startConversation(address: IAddress, callback: (err: Error, address?: IAddress) => void)
参数
- address
- IAddress
- callback
-
(err: Error, address?: IAddress) => void