ChatConnector class

Pacchetto:

botbuilder

Connette un UniversalBot a più canali tramite Bot Framework.

Costruttori

ChatConnector(IChatConnectorSettings)

Crea un nuovo elemento instnace di ChatConnector.

Metodi

delete(IAddress, (err: Error) => void)	Elimina un messaggio esistente.
deleteConversationMember(string, string, string, (err: Error) => void)	Elimina i dati per un singolo utente all'interno di una conversazione.
emulateOAuthCards(string, boolean, (err: Error) => void)	Indica al servizio token di emulare l'invio di OAuthCards.
exportBotStateData(string, string, string | undefined, (err: Error, results: IBotStateDataResult) => void)	Esporta i dati sullo stato del bot salvati in modo permanente per un determinato canale.
getAccessToken((err: Error, accessToken: string) => void)	Ottiene il token di accesso corrente per il bot.
getConversationPagedMembers(string, string, number | undefined, string | undefined, (err: Error, result?: IPagedMembersResult) => void)	Enumerare i membri di una conversazione una pagina alla volta. Questa API REST accetta un ConversationId. Facoltativamente, è possibile specificare pageSize e/o continuationToken. Restituisce un valore PagedMembersResult, che contiene una matrice di ChannelAccounts che rappresenta i membri della conversazione e un token di continuazione che può essere usato per ottenere più valori. Ogni chiamata restituisce una pagina di record ChannelAccounts. Il numero di record in una pagina può variare tra canali e chiamate. Il parametro pageSize può essere usato come suggerimento. Se non sono presenti risultati aggiuntivi, la risposta non conterrà un token di continuazione. Se nella conversazione non sono presenti membri, i membri saranno vuoti o non presenti nella risposta. Una risposta a una richiesta con un token di continuazione da una richiesta precedente può restituire raramente membri da una richiesta precedente.
getConversations(string, string | undefined, (err: Error, result?: IConversationsResult) => void)	Recupera un elenco di tutte le conversazioni presenti nel bot in un determinato canale. I risultati verranno inviati al bot in pagine insieme a un continuationToken che può essere usato per recuperare la pagina successiva delle conversazioni. Questi dati possono essere usati per eliminare tutti i dati della conversazione per un utente tramite il metodo deleteConversationMember().
getData(IBotStorageContext, (err: Error, data: IBotStorageData) => void)	Legge i dati dal servizio di stato di Bot Frameworks.
getSignInLink(IChatConnectorAddress, string, (err: Error, link: string) => void)	Ottiene un collegamento di accesso dal server token che può essere inviato come parte di signinCard.
getUserToken(IChatConnectorAddress, string, string | undefined, (err: Error, results: ITokenResponse) => void)	Tenta di recuperare il token per un utente che si trova in un flusso di accesso.
listen()	Registra un hook di stile Express o Restify per l'ascolto dei nuovi messaggi.
onEvent((events: IEvent[], callback?: (err: Error) => void) => void)	Chiamato da UniversalBot al momento della registrazione per registrare un gestore per la ricezione di eventi in ingresso da un canale.
onInvoke((event: IEvent, cb?: (err: Error, body: any, status?: number) => void) => void)	Utilizzato per registrare un gestore per la ricezione di eventi invoke in ingresso.
saveData(IBotStorageContext, IBotStorageData, (err: Error) => void)	Scrive i dati nel servizio di stato di Bot Frameworks.
send(IMessage[], (err: Error, addresses?: IAddress[]) => void)	Chiamato da UniversalBot per recapitare messaggi in uscita a un utente.
sendConversationHistory(string, string, ITranscript, (err: Error, results: any) => void)	Questo metodo consente di caricare le attività storiche nella conversazione. Il mittente deve assicurarsi che le attività cronologiche abbiano ID univoci e timestamp appropriati. Gli ID vengono usati dal client per gestire le attività duplicate e i timestamp vengono usati dal client per eseguire il rendering delle attività nell'ordine corretto.
signOutUser(IChatConnectorAddress, string, (err: Error, results: ITokenResponse) => void)	Disconnette l'utente con il server token.
startConversation(IAddress, (err: Error, address?: IAddress) => void)	Chiamato quando un UniversalBot vuole avviare una nuova conversazione proattiva con un utente. Il connettore deve restituire un indirizzo formattato correttamente oggetto con un campo conversazione popolato .
update(IMessage, (err: Error, address?: IAddress) => void)	Sostituisce un messaggio esistente con uno nuovo.

Dettagli costruttore

ChatConnector(IChatConnectorSettings)

Crea un nuovo elemento instnace di ChatConnector.

new ChatConnector(settings?: IChatConnectorSettings)

Parametri

settings

IChatConnectorSettings

(Facoltativo) parametri di configurazione che consentono di specificare l'ID app dei bot & Password assegnata nel portale per sviluppatori di Bot Frameworks.

Dettagli metodo

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

Elimina un messaggio esistente.

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

Parametri

address

IAddress

done

(err: Error) => void

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

Elimina i dati per un singolo utente all'interno di una conversazione.

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

Parametri

serviceUrl

string

URL del servizio per il canale da aggiornare. Questo è disponibile nella address.serviceUrl per un messaggio inviato al bot.

conversationId

string

ID della conversazione con il membro da eliminare.

memberId

string

ID del membro da eliminare.

done

(err: Error) => void

Callback richiamato al completamento dell'operazione di eliminazione.

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

Indica al servizio token di emulare l'invio di OAuthCards.

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

Parametri

serviceUrl

string

URL del servizio per il canale sottoposto a query. Questo è disponibile nella address.serviceUrl per un messaggio inviato al bot.

emulate

boolean

Se true il servizio token emula l'invio di OAuthCards.

done

(err: Error) => void

Callback richiamato al completamento dell'operazione.

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

Esporta i dati sullo stato del bot salvati in modo permanente per un determinato canale.

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

Parametri

serviceUrl

string

URL del servizio per il canale sottoposto a query. Questo è disponibile nella address.serviceUrl per un messaggio inviato al bot.

channelId

string

ID del canale esportato. Questo è disponibile nella address.channelId per un messaggio inviato al bot.

continuationToken

string | undefined

Token di continuazione per la pagina successiva dei risultati da recuperare. Deve essere undefined per la prima pagina richiesta.

done

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

Callback per ricevere la pagina successiva dei risultati.

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

Ottiene il token di accesso corrente per il bot.

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

Parametri

callback

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

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

Enumerare i membri di una conversazione una pagina alla volta. Questa API REST accetta un ConversationId. Facoltativamente, è possibile specificare pageSize e/o continuationToken. Restituisce un valore PagedMembersResult, che contiene una matrice di ChannelAccounts che rappresenta i membri della conversazione e un token di continuazione che può essere usato per ottenere più valori.

Ogni chiamata restituisce una pagina di record ChannelAccounts. Il numero di record in una pagina può variare tra canali e chiamate. Il parametro pageSize può essere usato come suggerimento. Se non sono presenti risultati aggiuntivi, la risposta non conterrà un token di continuazione. Se nella conversazione non sono presenti membri, i membri saranno vuoti o non presenti nella risposta.

Una risposta a una richiesta con un token di continuazione da una richiesta precedente può restituire raramente membri da una richiesta precedente.

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

Parametri

serviceUrl

string

URL del servizio per il canale sottoposto a query. Questo è disponibile nella address.serviceUrl per un messaggio inviato al bot.

conversationId

string

ConversationId

pageSize

number | undefined

Numero di risultati da ottenere (il valore predefinito è 20)

continuationToken

string | undefined

Token di continuazione per la pagina successiva dei risultati da recuperare. Deve essere undefined per la prima pagina richiesta.

done

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

Callback per ricevere la pagina successiva dei risultati.

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

Recupera un elenco di tutte le conversazioni presenti nel bot in un determinato canale. I risultati verranno inviati al bot in pagine insieme a un continuationToken che può essere usato per recuperare la pagina successiva delle conversazioni. Questi dati possono essere usati per eliminare tutti i dati della conversazione per un utente tramite il metodo deleteConversationMember().

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

Parametri

serviceUrl

string

URL del servizio per il canale sottoposto a query. Questo è disponibile nella address.serviceUrl per un messaggio inviato al bot.

continuationToken

string | undefined

Token di continuazione per la pagina successiva dei risultati da recuperare. Deve essere undefined per la prima pagina richiesta.

done

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

Callback per ricevere la pagina successiva dei risultati.

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

Legge i dati dal servizio di stato di Bot Frameworks.

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

Parametri

context

IBotStorageContext

callback

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

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

Ottiene un collegamento di accesso dal server token che può essere inviato come parte di signinCard.

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

Parametri

address

IChatConnectorAddress

Indirizzo dell'utente e del canale per cui ottenere il collegamento di accesso.

connectionName

string

Nome della connessione di autenticazione da usare.

done

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

Callback per recuperare il collegamento.

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

Tenta di recuperare il token per un utente che si trova in un flusso di accesso.

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

Parametri

address

IChatConnectorAddress

Indirizzo dell'utente e del canale per l'accesso.

connectionName

string

Nome della connessione di autenticazione da usare.

magicCode

string | undefined

(Facoltativo) Codice immesso dall'utente facoltativo da convalidare.

done

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

Callback per recuperare il token degli utenti.

listen()

Registra un hook di stile Express o Restify per l'ascolto dei nuovi messaggi.

function listen()

Restituisce

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

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

Chiamato da UniversalBot al momento della registrazione per registrare un gestore per la ricezione di eventi in ingresso da un canale.

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

Parametri

handler

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

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

Utilizzato per registrare un gestore per la ricezione di eventi invoke in ingresso.

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

Parametri

handler

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

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

Scrive i dati nel servizio di stato di Bot Frameworks.

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

Parametri

context

IBotStorageContext

data

IBotStorageData

callback

(err: Error) => void

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

Chiamato da UniversalBot per recapitare messaggi in uscita a un utente.

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

Parametri

messages

IMessage[]

done

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

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

Questo metodo consente di caricare le attività storiche nella conversazione. Il mittente deve assicurarsi che le attività cronologiche abbiano ID univoci e timestamp appropriati. Gli ID vengono usati dal client per gestire le attività duplicate e i timestamp vengono usati dal client per eseguire il rendering delle attività nell'ordine corretto.

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

Parametri

serviceUrl

string

URL del servizio per il canale sottoposto a query. Questo è disponibile nella address.serviceUrl per un messaggio inviato al bot.

conversationId

string

ID della conversazione con la cronologia da inviare.

transcript

ITranscript

done

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

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

Disconnette l'utente con il server token.

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

Parametri

address

IChatConnectorAddress

Indirizzo dell'utente e del canale da disconnettere.

connectionName

string

Nome della connessione di autenticazione da usare.

done

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

Callback per recuperare il token degli utenti.

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

Chiamato quando un UniversalBot vuole avviare una nuova conversazione proattiva con un utente. Il connettore deve restituire un indirizzo formattato correttamente oggetto con un campo conversazione popolato .

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

Parametri

address

IAddress

done

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

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

Sostituisce un messaggio esistente con uno nuovo.

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

Parametri

message

IMessage

done

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