IConnector interface

Pacote:

botbuilder

Implementado por plug-ins de conector para o UniversalBot.

Métodos

delete(IAddress, (err: Error) => void)	Método (opcional) que pode ser chamado para excluir uma mensagem que foi enviada anteriormente usando send().
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)	Chamado pelo UniversalBot no momento do registro para registrar um manipulador para receber eventos de entrada de um canal.
onInvoke((event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)	(Opcional) Chamado pelo UniversalBot no momento do registro para registrar um manipulador para receber eventos de invocação de entrada. Os eventos de invocação são eventos especiais que devem retornar um corpo embutido como parte da resposta à solicitação recebida.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	Envia mensagens de saída para um usuário. Esse método será chamado sempre que você chamar UniversalBot.send() ou Session.send(). Você pode chamar manualmente esse método usando session.connector.send() como uma maneira conveniente de obter o endereço da mensagem que foi enviada. Em seguida, você pode armazenar esse endereço e usá-lo em um momento posterior para atualizar ou excluir a mensagem. A única coisa a ter em mente é que, se você chamar manualmente session.connector.send() ignorará qualquer middleware pelo qual a mensagem de saída normalmente seria executada. Chamar session.send(msg).sendBatch(function (err, addresses) { }) faz a mesma coisa, mas garante que a mensagem de saída seja enviada por meio do middleware.
startConversation(IAddress, (err: Error, address?: IAddress) => void)	Chamado quando um UniversalBot deseja iniciar uma nova conversa proativa com um usuário. O conector deve retornar um endereço com um campo de IAddress.conversation de formatado corretamente. Isso normalmente será chamado quando você chamar UniversalBot.beginDialog(), mas também será chamado a qualquer momento IAddress.conversation for nulo para uma mensagem que está sendo enviada.
update(IMessage, (err: Error, address?: IAddress) => void)	Método (opcional) que pode ser chamado para substituir uma mensagem que foi enviada anteriormente usando send().

Detalhes do método

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

Método (opcional) que pode ser chamado para excluir uma mensagem que foi enviada anteriormente usando send().

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

Parâmetros

address

IAddress

O endereço da mensagem a ser excluída.

callback

(err: Error) => void

Função a ser invocada após a conclusão da operação.

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

Chamado pelo UniversalBot no momento do registro para registrar um manipulador para receber eventos de entrada de um canal.

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

Parâmetros

handler

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

A função que deve ser chamada sempre que um evento é recebido que não é do tipo "invoke".

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

(Opcional) Chamado pelo UniversalBot no momento do registro para registrar um manipulador para receber eventos de invocação de entrada. Os eventos de invocação são eventos especiais que devem retornar um corpo embutido como parte da resposta à solicitação recebida.

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

A função que deve ser chamada sempre que um evento "invoke" é recebido.

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

Envia mensagens de saída para um usuário. Esse método será chamado sempre que você chamar UniversalBot.send() ou Session.send(). Você pode chamar manualmente esse método usando session.connector.send() como uma maneira conveniente de obter o endereço da mensagem que foi enviada. Em seguida, você pode armazenar esse endereço e usá-lo em um momento posterior para atualizar ou excluir a mensagem. A única coisa a ter em mente é que, se você chamar manualmente session.connector.send() ignorará qualquer middleware pelo qual a mensagem de saída normalmente seria executada. Chamar session.send(msg).sendBatch(function (err, addresses) { }) faz a mesma coisa, mas garante que a mensagem de saída seja enviada por meio do middleware.

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

Parâmetros

messages

IMessage[]

Matriz de mensagens para enviar o usuário.

callback

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

Função a ser invocada após a conclusão da operação.

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

Chamado quando um UniversalBot deseja iniciar uma nova conversa proativa com um usuário. O conector deve retornar um endereço com um campo de IAddress.conversation de formatado corretamente. Isso normalmente será chamado quando você chamar UniversalBot.beginDialog(), mas também será chamado a qualquer momento IAddress.conversation for nulo para uma mensagem que está sendo enviada.

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

Parâmetros

address

IAddress

O endereço do usuário para o qual iniciar a conversa. O campo IAddress.conversation deve ser nulo.

callback

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

Função a ser invocada após a conclusão da operação.

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

Método (opcional) que pode ser chamado para substituir uma mensagem que foi enviada anteriormente usando send().

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

Parâmetros

message

IMessage

A mensagem com a qual substituir uma mensagem existente. O campo message.address deve conter um endereço retornado de uma chamada anterior para send().

callback

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

Função a ser invocada após a conclusão da operação.