IConnector interface
UniversalBot のコネクタ プラグインによって実装されます。
メソッド
| delete(IAddress, (err: Error) => void) | (省略可能) send()を使用して以前に送信されたメッセージを削除するために呼び出すことができるメソッド。 |
| on |
登録時に UniversalBot によって呼び出され、チャネルから受信イベントを受信するためのハンドラーを登録します。 |
| on |
(省略可能)登録時に UniversalBot によって呼び出され、着信呼び出しイベントを受信するためのハンドラーを登録します。 呼び出しイベントは、受信した要求への応答の一部として本文をインラインで返す特別なイベントです。 |
| send(IMessage[], (err: Error, addresses?: IAddress[]) => void) | 送信メッセージをユーザーに送信します。 このメソッドは最終的に、UniversalBot.send() または |
| start |
UniversalBot がユーザーとの新しいプロアクティブな会話を開始する場合に呼び出されます。 コネクタは、IAddress.conversation フィールド |
| update(IMessage, (err: Error, address?: IAddress) => void) | (省略可能) send()を使用して以前に送信されたメッセージ |
メソッドの詳細
delete(IAddress, (err: Error) => void)
(省略可能) send()を使用して以前に送信されたメッセージを削除するために呼び出すことができるメソッド。
function delete(address: IAddress, callback: (err: Error) => void)パラメーター
- address
- IAddress
削除するメッセージのアドレス。
- callback
-
(err: Error) => void
操作が完了したら呼び出す関数。
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
"invoke" 型ではないイベントを受信するたびに呼び出す必要がある関数。
onInvoke((event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)
(省略可能)登録時に UniversalBot によって呼び出され、着信呼び出しイベントを受信するためのハンドラーを登録します。 呼び出しイベントは、受信した要求への応答の一部として本文をインラインで返す特別なイベントです。
function onInvoke(handler: (event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)パラメーター
- handler
-
(event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void
"invoke" イベントが受信されるたびに呼び出す必要がある関数。
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)
送信メッセージをユーザーに送信します。 このメソッドは最終的に、UniversalBot.send() または session.connector.send() を使用して、このメソッドを手動で呼び出すことができます。 その後、このアドレスを保存し、後でメッセージを更新または削除するために使用できます。 注意すべき 1 つの点は、session.connector.send() を手動で呼び出した場合、送信メッセージが通常実行するミドルウェアをバイパスするということです。
session.send(msg).sendBatch(function (err, addresses) { }) を呼び出すと同じ処理が行われますが、送信メッセージがミドルウェアを介して確実に送信されます。
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 がユーザーとの新しいプロアクティブな会話を開始する場合に呼び出されます。 コネクタは、IAddress.conversation フィールド
function startConversation(address: IAddress, callback: (err: Error, address?: IAddress) => void)パラメーター
- address
- IAddress
会話を開始するユーザーのアドレス。
IAddress.conversation フィールドは null にする必要があります。
- callback
-
(err: Error, address?: IAddress) => void
操作が完了したら呼び出す関数。
update(IMessage, (err: Error, address?: IAddress) => void)
(省略可能) send()を使用して以前に送信されたメッセージ
function update(message: IMessage, callback: (err: Error, address?: IAddress) => void)パラメーター
- message
- IMessage
既存のメッセージを上書きするメッセージ。
- callback
-
(err: Error, address?: IAddress) => void
操作が完了したら呼び出す関数。