IConnector interface

Paquet:

botbuilder

Implémenté par les plug-ins de connecteur pour UniversalBot.

Méthodes

delete(IAddress, (err: Error) => void)	(Facultatif) méthode qui peut être appelée pour supprimer un message précédemment envoyé à l’aide de send().
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)	Appelé par universalBot au moment de l’inscription pour inscrire un gestionnaire pour recevoir des événements entrants à partir d’un canal.
onInvoke((event: IEvent, callback?: (err: Error, body: any, status?: number) => void) => void)	(Facultatif) Appelé par universalBot au moment de l’inscription pour inscrire un gestionnaire pour recevoir des événements d’appel entrants. Les événements d’appel sont des événements spéciaux qui sont censés retourner un corps inline dans le cadre de la réponse à la demande reçue.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	Envoie des messages sortants à un utilisateur. Cette méthode sera finalement appelée chaque fois que vous appelez UniversalBot.send() ou Session.send(). Vous pouvez appeler manuellement cette méthode à l’aide de session.connector.send() comme moyen pratique d’obtenir l’adresse du message envoyé. Vous pouvez ensuite stocker cette adresse et l’utiliser ultérieurement pour mettre à jour ou supprimer le message. La seule chose à garder à l’esprit est que si vous appelez manuellement session.connector.send() vous contournerez tout intergiciel que le message sortant exécuterait normalement. L’appel de session.send(msg).sendBatch(function (err, addresses) { }) fait la même chose, mais garantit que le message sortant est envoyé par le biais d’un intergiciel.
startConversation(IAddress, (err: Error, address?: IAddress) => void)	Appelé lorsqu’un UniversalBot souhaite démarrer une nouvelle conversation proactive avec un utilisateur. Le connecteur doit retourner une adresse avec un champ IAddress.conversation correctement mis en forme. Cela sera généralement appelé lorsque vous appelez UniversalBot.beginDialog(), mais sera également appelé chaque fois que IAddress.conversation est null pour un message envoyé.
update(IMessage, (err: Error, address?: IAddress) => void)	(Facultatif) méthode qui peut être appelée pour remplacer un message précédemment envoyé à l’aide de send().

Détails de la méthode

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

(Facultatif) méthode qui peut être appelée pour supprimer un message précédemment envoyé à l’aide de send().

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

Paramètres

address

IAddress

Adresse du message à supprimer.

callback

(err: Error) => void

Fonction à appeler une fois l’opération terminée.

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

Appelé par universalBot au moment de l’inscription pour inscrire un gestionnaire pour recevoir des événements entrants à partir d’un canal.

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

Paramètres

handler

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

Fonction qui doit être appelée chaque fois qu’un événement est reçu qui n’est pas de type « invoke ».

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

(Facultatif) Appelé par universalBot au moment de l’inscription pour inscrire un gestionnaire pour recevoir des événements d’appel entrants. Les événements d’appel sont des événements spéciaux qui sont censés retourner un corps inline dans le cadre de la réponse à la demande reçue.

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

Paramètres

handler

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

Fonction qui doit être appelée chaque fois qu’un événement « invoke » est reçu.

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

Envoie des messages sortants à un utilisateur. Cette méthode sera finalement appelée chaque fois que vous appelez UniversalBot.send() ou Session.send(). Vous pouvez appeler manuellement cette méthode à l’aide de session.connector.send() comme moyen pratique d’obtenir l’adresse du message envoyé. Vous pouvez ensuite stocker cette adresse et l’utiliser ultérieurement pour mettre à jour ou supprimer le message. La seule chose à garder à l’esprit est que si vous appelez manuellement session.connector.send() vous contournerez tout intergiciel que le message sortant exécuterait normalement. L’appel de session.send(msg).sendBatch(function (err, addresses) { }) fait la même chose, mais garantit que le message sortant est envoyé par le biais d’un intergiciel.

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

Paramètres

messages

IMessage[]

Tableau de messages à envoyer à l’utilisateur.

callback

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

Fonction à appeler une fois l’opération terminée.

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

Appelé lorsqu’un UniversalBot souhaite démarrer une nouvelle conversation proactive avec un utilisateur. Le connecteur doit retourner une adresse avec un champ IAddress.conversation correctement mis en forme. Cela sera généralement appelé lorsque vous appelez UniversalBot.beginDialog(), mais sera également appelé chaque fois que IAddress.conversation est null pour un message envoyé.

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

Paramètres

address

IAddress

Adresse de l’utilisateur pour laquelle démarrer la conversation. Le champ IAddress.conversation doit être null.

callback

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

Fonction à appeler une fois l’opération terminée.

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

(Facultatif) méthode qui peut être appelée pour remplacer un message précédemment envoyé à l’aide de send().

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

Paramètres

message

IMessage

Message avec qui remplacer un message existant. Le champ message.address doit contenir une adresse retournée par un appel précédent à send().

callback

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

Fonction à appeler une fois l’opération terminée.