Partager via


ConsoleConnector class

Connecte un UniversalBot à la ligne de commande via une fenêtre de console.

Méthodes

listen()

Démarre le connecteur à l’écoute de stdIn.

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, cb?: (err: Error, body: any, status?: number) => void) => void)

Permet d’inscrire un gestionnaire pour recevoir des événements d’appel entrants.

processEvent(IEvent)

Envoie un événement via le connecteur.

processMessage(string)

Envoie un message via le connecteur.

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

Appelé par UniversalBot pour remettre des messages sortants à un utilisateur.

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 correctement mise en forme objet avec un champ de conversation rempli.

Détails de la méthode

listen()

Démarre le connecteur à l’écoute de stdIn.

function listen()

Retours

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

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

Permet d’inscrire un gestionnaire pour recevoir des événements d’appel entrants.

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

Paramètres

handler

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

processEvent(IEvent)

Envoie un événement via le connecteur.

function processEvent(event: IEvent)

Paramètres

event
IEvent

Retours

processMessage(string)

Envoie un message via le connecteur.

function processMessage(line: string)

Paramètres

line

string

Retours

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

Appelé par UniversalBot pour remettre des messages sortants à un utilisateur.

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

Paramètres

messages

IMessage[]

callback

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

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 correctement mise en forme objet avec un champ de conversation rempli.

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

Paramètres

address
IAddress
callback

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