IConnector interface

Paquete:

botbuilder

Implementado por complementos de conector para UniversalBot.

Métodos

delete(IAddress, (err: Error) => void)	(Opcional) método al que se puede llamar para eliminar un mensaje que se envió anteriormente mediante send().
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)	Llamado por UniversalBot en el momento de registro para registrar un controlador para recibir eventos entrantes de un canal.
onInvoke((event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)	(Opcional) Lo llama UniversalBot en el momento del registro para registrar un controlador para recibir eventos de invocación entrantes. Los eventos de invocación son eventos especiales que se espera que devuelvan un cuerpo insertado como parte de la respuesta a la solicitud recibida.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	Envía mensajes salientes a un usuario. Este método se llamará en última instancia cada vez que llame a UniversalBot.send() o Session.send(). Puede llamar manualmente a este método mediante session.connector.send() como una forma cómoda de obtener la dirección del mensaje que se envió. A continuación, puede almacenar esta dirección y usarla en un momento posterior para actualizar o eliminar el mensaje. Lo único que hay que tener en cuenta es que si llama manualmente a session.connector.send() omitirá cualquier middleware que el mensaje saliente se ejecutaría normalmente. Llamar a session.send(msg).sendBatch(function (err, addresses) { }) hace lo mismo, pero garantiza que el mensaje saliente se envíe a través del middleware.
startConversation(IAddress, (err: Error, address?: IAddress) => void)	Se llama cuando un UniversalBot quiere iniciar una nueva conversación proactiva con un usuario. El conector debe devolver una dirección con un campo IAddress. conversation con el formato correcto. Normalmente, se llamará cuando llame a UniversalBot.beginDialog(), pero también se llamará en cualquier momento IAddress.conversation sea null para enviar un mensaje.
update(IMessage, (err: Error, address?: IAddress) => void)	(Opcional) método al que se puede llamar para reemplazar un mensaje que se envió anteriormente mediante send().

Detalles del método

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

(Opcional) método al que se puede llamar para eliminar un mensaje que se envió anteriormente mediante send().

function delete(address: IAddress, callback: (err: Error) => void)

Parámetros

address

IAddress

Dirección del mensaje que se va a eliminar.

callback

(err: Error) => void

Función que se va a invocar una vez completada la operación.

onEvent((events: IEvent[], callback?: (err: Error) => void) => void)

Llamado por UniversalBot en el momento de registro para registrar un controlador para recibir eventos entrantes de un canal.

function onEvent(handler: (events: IEvent[], callback?: (err: Error) => void) => void)

Parámetros

handler

(events: IEvent[], callback?: (err: Error) => void) => void

Función a la que se debe llamar cada vez que se recibe un evento que no es de tipo "invoke".

onInvoke((event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)

(Opcional) Lo llama UniversalBot en el momento del registro para registrar un controlador para recibir eventos de invocación entrantes. Los eventos de invocación son eventos especiales que se espera que devuelvan un cuerpo insertado como parte de la respuesta a la solicitud recibida.

function onInvoke(handler: (event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)

Parámetros

handler

(event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void

Se recibe la función que se debe llamar en cualquier momento en que se reciba un evento "invoke".

send(IMessage[], (err: Error, addresses?: IAddress[]) => void)

Envía mensajes salientes a un usuario. Este método se llamará en última instancia cada vez que llame a UniversalBot.send() o Session.send(). Puede llamar manualmente a este método mediante session.connector.send() como una forma cómoda de obtener la dirección del mensaje que se envió. A continuación, puede almacenar esta dirección y usarla en un momento posterior para actualizar o eliminar el mensaje. Lo único que hay que tener en cuenta es que si llama manualmente a session.connector.send() omitirá cualquier middleware que el mensaje saliente se ejecutaría normalmente. Llamar a session.send(msg).sendBatch(function (err, addresses) { }) hace lo mismo, pero garantiza que el mensaje saliente se envíe a través del middleware.

function send(messages: IMessage[], callback: (err: Error, addresses?: IAddress[]) => void)

Parámetros

messages

IMessage[]

Matriz de mensajes para enviar al usuario.

callback

(err: Error, addresses?: IAddress[]) => void

Función que se va a invocar una vez completada la operación.

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

Se llama cuando un UniversalBot quiere iniciar una nueva conversación proactiva con un usuario. El conector debe devolver una dirección con un campo IAddress. conversation con el formato correcto. Normalmente, se llamará cuando llame a UniversalBot.beginDialog(), pero también se llamará en cualquier momento IAddress.conversation sea null para enviar un mensaje.

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

Parámetros

address

IAddress

Dirección del usuario para la que se va a iniciar la conversación. El campo IAddress.conversation debe ser NULL.

callback

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

Función que se va a invocar una vez completada la operación.

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

(Opcional) método al que se puede llamar para reemplazar un mensaje que se envió anteriormente mediante send().

function update(message: IMessage, callback: (err: Error, address?: IAddress) => void)

Parámetros

message

IMessage

Mensaje con el que se sobrescribe un mensaje existente. El campo message.address debe contener una dirección devuelta de una llamada anterior a send().

callback

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

Función que se va a invocar una vez completada la operación.