ChatConnector class

Paquet:

botbuilder

Connecte un UniversalBot à plusieurs canaux via Bot Framework.

Constructeurs

ChatConnector(IChatConnectorSettings)

Crée un instnace de ChatConnector.

Méthodes

delete(IAddress, (err: Error) => void)	Supprime un message existant.
deleteConversationMember(string, string, string, (err: Error) => void)	Supprime les données d’un utilisateur individuel au sein d’une conversation.
emulateOAuthCards(string, boolean, (err: Error) => void)	Indique au service de jeton d’émuler l’envoi d’OAuthCards.
exportBotStateData(string, string, string | undefined, (err: Error, results: IBotStateDataResult) => void)	Exporte les données d’état du bot conservées pour un canal donné.
getAccessToken((err: Error, accessToken: string) => void)	Obtient le jeton d’accès actuel pour le bot.
getConversationPagedMembers(string, string, number | undefined, string | undefined, (err: Error, result?: IPagedMembersResult) => void)	Énumérez les membres d’une conversation d’une page à la fois. Cette API REST prend un ConversationId. Vous pouvez éventuellement fournir une pageSize et/ou continuationToken. Elle retourne un PagedMembersResult, qui contient un tableau de ChannelAccounts représentant les membres de la conversation et un jeton de continuation qui peut être utilisé pour obtenir plus de valeurs. Une page d’enregistrements ChannelAccounts est retournée avec chaque appel. Le nombre d’enregistrements d’une page peut varier entre les canaux et les appels. Le paramètre pageSize peut être utilisé comme suggestion. S’il n’existe aucun résultat supplémentaire, la réponse ne contient pas de jeton de continuation. S’il n’y a aucun membre dans la conversation, les membres sont vides ou ne sont pas présents dans la réponse. Une réponse à une demande qui a un jeton de continuation d’une demande antérieure peut rarement renvoyer des membres d’une demande précédente.
getConversations(string, string | undefined, (err: Error, result?: IConversationsResult) => void)	Récupère une liste de toutes les conversations que le bot a sur un canal donné. Les résultats seront renvoyés au bot dans les pages, ainsi qu’un continuationToken qui peut être utilisé pour extraire la page suivante des conversations. Ces données peuvent être utilisées pour supprimer toutes les données de conversation d’un utilisateur via la méthode deleteConversationMember().
getData(IBotStorageContext, (err: Error, data: IBotStorageData) => void)	Lit dans les données du service d’état Bot Frameworks.
getSignInLink(IChatConnectorAddress, string, (err: Error, link: string) => void)	Obtient un lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard.
getUserToken(IChatConnectorAddress, string, string | undefined, (err: Error, results: ITokenResponse) => void)	Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion.
listen()	Inscrit un hook de style Express ou Restify pour écouter les nouveaux messages.
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.
saveData(IBotStorageContext, IBotStorageData, (err: Error) => void)	Écrit des données dans le service d’état Bot Frameworks.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	Appelé par UniversalBot pour remettre des messages sortants à un utilisateur.
sendConversationHistory(string, string, ITranscript, (err: Error, results: any) => void)	Cette méthode vous permet de charger les activités historiques dans la conversation. L’expéditeur doit s’assurer que les activités historiques ont des ID uniques et des horodatages appropriés. Les ID sont utilisés par le client pour traiter les activités en double et les horodatages sont utilisés par le client pour afficher les activités dans l’ordre approprié.
signOutUser(IChatConnectorAddress, string, (err: Error, results: ITokenResponse) => void)	Déconnecte l’utilisateur avec le serveur de jetons.
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.
update(IMessage, (err: Error, address?: IAddress) => void)	Remplace un message existant par un nouveau message.

Détails du constructeur

ChatConnector(IChatConnectorSettings)

Crée un instnace de ChatConnector.

new ChatConnector(settings?: IChatConnectorSettings)

Paramètres

settings

IChatConnectorSettings

(Facultatif) les paramètres de configuration qui vous permettent de spécifier l’ID d’application des bots & mot de passe que vous avez affecté dans le portail des développeurs Bot Frameworks.

Détails de la méthode

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

Supprime un message existant.

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

Paramètres

address

IAddress

done

(err: Error) => void

deleteConversationMember(string, string, string, (err: Error) => void)

Supprime les données d’un utilisateur individuel au sein d’une conversation.

function deleteConversationMember(serviceUrl: string, conversationId: string, memberId: string, done: (err: Error) => void)

Paramètres

serviceUrl

string

URL du service pour le canal mis à jour. Vous trouverez cela dans la address.serviceUrl pour un message envoyé au bot.

conversationId

string

ID de la conversation avec le membre à supprimer.

memberId

string

ID du membre à supprimer.

done

(err: Error) => void

Rappel appelé à la fin de l’opération de suppression.

emulateOAuthCards(string, boolean, (err: Error) => void)

Indique au service de jeton d’émuler l’envoi d’OAuthCards.

function emulateOAuthCards(serviceUrl: string, emulate: boolean, done: (err: Error) => void)

Paramètres

serviceUrl

string

URL du service pour le canal interrogé. Vous trouverez cela dans la address.serviceUrl pour un message envoyé au bot.

emulate

boolean

Si true le service de jeton émule l’envoi d’OAuthCards.

done

(err: Error) => void

Rappel appelé à la fin de l’opération.

exportBotStateData(string, string, string | undefined, (err: Error, results: IBotStateDataResult) => void)

Exporte les données d’état du bot conservées pour un canal donné.

function exportBotStateData(serviceUrl: string, channelId: string, continuationToken: string | undefined, done: (err: Error, results: IBotStateDataResult) => void)

Paramètres

serviceUrl

string

URL du service pour le canal interrogé. Vous trouverez cela dans la address.serviceUrl pour un message envoyé au bot.

channelId

string

ID du canal en cours d’exportation. Vous trouverez cela dans la address.channelId pour un message envoyé au bot.

continuationToken

string | undefined

Jeton de continuation pour la page suivante des résultats à extraire. Cela doit être undefined pour la première page demandée.

done

(err: Error, results: IBotStateDataResult) => void

Rappel pour recevoir la page suivante des résultats.

getAccessToken((err: Error, accessToken: string) => void)

Obtient le jeton d’accès actuel pour le bot.

function getAccessToken(callback: (err: Error, accessToken: string) => void)

Paramètres

callback

(err: Error, accessToken: string) => void

getConversationPagedMembers(string, string, number | undefined, string | undefined, (err: Error, result?: IPagedMembersResult) => void)

Énumérez les membres d’une conversation d’une page à la fois. Cette API REST prend un ConversationId. Vous pouvez éventuellement fournir une pageSize et/ou continuationToken. Elle retourne un PagedMembersResult, qui contient un tableau de ChannelAccounts représentant les membres de la conversation et un jeton de continuation qui peut être utilisé pour obtenir plus de valeurs.

Une page d’enregistrements ChannelAccounts est retournée avec chaque appel. Le nombre d’enregistrements d’une page peut varier entre les canaux et les appels. Le paramètre pageSize peut être utilisé comme suggestion. S’il n’existe aucun résultat supplémentaire, la réponse ne contient pas de jeton de continuation. S’il n’y a aucun membre dans la conversation, les membres sont vides ou ne sont pas présents dans la réponse.

Une réponse à une demande qui a un jeton de continuation d’une demande antérieure peut rarement renvoyer des membres d’une demande précédente.

function getConversationPagedMembers(serviceUrl: string, conversationId: string, pageSize: number | undefined, continuationToken: string | undefined, done: (err: Error, result?: IPagedMembersResult) => void)

Paramètres

serviceUrl

string

URL du service pour le canal interrogé. Vous trouverez cela dans la address.serviceUrl pour un message envoyé au bot.

conversationId

string

ConversationId

pageSize

number | undefined

Nombre de résultats à obtenir (la valeur par défaut est 20)

continuationToken

string | undefined

Jeton de continuation pour la page suivante des résultats à extraire. Cela doit être undefined pour la première page demandée.

done

(err: Error, result?: IPagedMembersResult) => void

Rappel pour recevoir la page suivante des résultats.

getConversations(string, string | undefined, (err: Error, result?: IConversationsResult) => void)

Récupère une liste de toutes les conversations que le bot a sur un canal donné. Les résultats seront renvoyés au bot dans les pages, ainsi qu’un continuationToken qui peut être utilisé pour extraire la page suivante des conversations. Ces données peuvent être utilisées pour supprimer toutes les données de conversation d’un utilisateur via la méthode deleteConversationMember().

function getConversations(serviceUrl: string, continuationToken: string | undefined, done: (err: Error, result?: IConversationsResult) => void)

Paramètres

serviceUrl

string

URL du service pour le canal interrogé. Vous trouverez cela dans la address.serviceUrl pour un message envoyé au bot.

continuationToken

string | undefined

Jeton de continuation pour la page suivante des résultats à extraire. Cela doit être undefined pour la première page demandée.

done

(err: Error, result?: IConversationsResult) => void

Rappel pour recevoir la page suivante des résultats.

getData(IBotStorageContext, (err: Error, data: IBotStorageData) => void)

Lit dans les données du service d’état Bot Frameworks.

function getData(context: IBotStorageContext, callback: (err: Error, data: IBotStorageData) => void)

Paramètres

context

IBotStorageContext

callback

(err: Error, data: IBotStorageData) => void

getSignInLink(IChatConnectorAddress, string, (err: Error, link: string) => void)

Obtient un lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard.

function getSignInLink(address: IChatConnectorAddress, connectionName: string, done: (err: Error, link: string) => void)

Paramètres

address

IChatConnectorAddress

Adresse de l’utilisateur et du canal pour obtenir le lien de connexion.

connectionName

string

Nom de la connexion d’authentification à utiliser.

done

(err: Error, link: string) => void

Rappel pour récupérer le lien.

getUserToken(IChatConnectorAddress, string, string | undefined, (err: Error, results: ITokenResponse) => void)

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion.

function getUserToken(address: IChatConnectorAddress, connectionName: string, magicCode: string | undefined, done: (err: Error, results: ITokenResponse) => void)

Paramètres

address

IChatConnectorAddress

Adresse de l’utilisateur et du canal à connecter.

connectionName

string

Nom de la connexion d’authentification à utiliser.

magicCode

string | undefined

(Facultatif) Un utilisateur facultatif a entré du code pour valider.

done

(err: Error, results: ITokenResponse) => void

Rappel pour récupérer le jeton des utilisateurs.

listen()

Inscrit un hook de style Express ou Restify pour écouter les nouveaux messages.

function listen()

Retours

(req: any, res: any) => void

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

saveData(IBotStorageContext, IBotStorageData, (err: Error) => void)

Écrit des données dans le service d’état Bot Frameworks.

function saveData(context: IBotStorageContext, data: IBotStorageData, callback?: (err: Error) => void)

Paramètres

context

IBotStorageContext

data

IBotStorageData

callback

(err: Error) => void

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

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

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

Paramètres

messages

IMessage[]

done

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

sendConversationHistory(string, string, ITranscript, (err: Error, results: any) => void)

Cette méthode vous permet de charger les activités historiques dans la conversation. L’expéditeur doit s’assurer que les activités historiques ont des ID uniques et des horodatages appropriés. Les ID sont utilisés par le client pour traiter les activités en double et les horodatages sont utilisés par le client pour afficher les activités dans l’ordre approprié.

function sendConversationHistory(serviceUrl: string, conversationId: string, transcript: ITranscript, done: (err: Error, results: any) => void)

Paramètres

serviceUrl

string

URL du service pour le canal interrogé. Vous trouverez cela dans la address.serviceUrl pour un message envoyé au bot.

conversationId

string

ID de la conversation avec l’historique à envoyer.

transcript

ITranscript

done

(err: Error, results: any) => void

signOutUser(IChatConnectorAddress, string, (err: Error, results: ITokenResponse) => void)

Déconnecte l’utilisateur avec le serveur de jetons.

function signOutUser(address: IChatConnectorAddress, connectionName: string, done: (err: Error, results: ITokenResponse) => void)

Paramètres

address

IChatConnectorAddress

Adresse de l’utilisateur et du canal à déconnecter.

connectionName

string

Nom de la connexion d’authentification à utiliser.

done

(err: Error, results: ITokenResponse) => void

Rappel pour récupérer le jeton des utilisateurs.

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, done: (err: Error, address?: IAddress) => void)

Paramètres

address

IAddress

done

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

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

Remplace un message existant par un nouveau message.

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

Paramètres

message

IMessage

done

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