Поделиться через

IConnector interface

  • Ссылка
Пакет:
botbuilder

Реализованы подключаемыми модулями соединителей для UniversalBot.

Методы

delete(IAddress, (err: Error) => void)

(Необязательно) метод, который можно вызвать для удаления сообщения, которое ранее было отправлено с помощью send().
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)

Вызывается universalBot во время регистрации для регистрации обработчика для получения входящих событий из канала.
onInvoke((event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)

(Необязательно) Вызывается универсальным ботом во время регистрации для регистрации обработчика для получения входящих событий вызова. Вызов событий — это специальные события, которые, как ожидается, возвращают встроенный текст в рамках ответа на полученный запрос.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)

Отправляет исходящие сообщения пользователю. Этот метод в конечном счете вызывается в любое время, когда вы вызываете UniversalBot.send() или Session.send(). Этот метод можно вызвать вручную с помощью session.connector.send() как удобный способ получения адреса отправленного сообщения. Затем вы можете сохранить этот адрес и использовать его в последующий момент времени для обновления или удаления сообщения. Единственное, что следует помнить, что если вы вручную вызываете session.connector.send() вы будете обходить любое ПО промежуточного слоя, через которое обычно выполняется исходящее сообщение. Вызов session.send(msg).sendBatch(function (err, addresses) { }) выполняет то же самое, но гарантирует, что исходящее сообщение отправляется через ПО промежуточного слоя.
startConversation(IAddress, (err: Error, address?: IAddress) => void)

Вызывается, когда UniversalBot хочет начать новую упреждающая беседу с пользователем. Соединитель должен возвращать адрес с правильным форматом поле IAddress.conversation. Это обычно вызывается при вызове UniversalBot.beginDialog(), но также вызывается в любое время, IAddress.conversation имеет значение NULL для отправки сообщения.
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)

(Необязательно) Вызывается универсальным ботом во время регистрации для регистрации обработчика для получения входящих событий вызова. Вызов событий — это специальные события, которые, как ожидается, возвращают встроенный текст в рамках ответа на полученный запрос.

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.send(). Этот метод можно вызвать вручную с помощью session.connector.send() как удобный способ получения адреса отправленного сообщения. Затем вы можете сохранить этот адрес и использовать его в последующий момент времени для обновления или удаления сообщения. Единственное, что следует помнить, что если вы вручную вызываете 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. Это обычно вызывается при вызове UniversalBot.beginDialog(), но также вызывается в любое время, IAddress.conversation имеет значение NULL для отправки сообщения.

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

Сообщение для перезаписи существующего сообщения. Поле message.address должно содержать адрес, возвращенный предыдущим вызовом send().

callback

(err: Error, address?: IAddress) => void

Функция для вызова после завершения операции.