Condividi tramite


botbuilder package

Classi

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase

ChannelServiceHandlerBase implementa l'API per inoltrare l'attività a una competenza e implementa il routing delle chiamate ChannelAPI dalla competenza tramite bot/adapter.

ChannelServiceRoutes

Instrada le chiamate API con i metodi ChannelServiceHandler.

CloudAdapter

Adattatore che implementa il protocollo Bot Framework e può essere ospitato in ambienti cloud diversi sia pubblici che privati.

CloudChannelServiceHandler

Classe per facilitare l'implementazione del protocollo bot Framework usando BotFrameworkAuthentication.

EventFactory

Contiene metodi di utilità per la creazione di vari tipi di evento.

FileTranscriptStore

L'archivio trascrizioni file archivia le trascrizioni nel file system con ogni attività come file.

HandoffEventNames

Definisce i valori per i nomi degli eventi di handoff.

InspectionMiddleware

InspectionMiddleware per l'ispezione dell'emulatore delle attività di runtime e di BotState.

InspectionState

InspectionState per l'uso da parte di InspectionMiddleware per l'ispezione dell'emulatore delle attività di runtime e di BotState.

RouteConstants

Costanti che rappresentano il percorso API che segue immediatamente basePath. Questi sono attualmente interni, ma verranno rivalutati rendendoli pubblici, in futuro.

esempio di

RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.

SetSpeakMiddleware

Supportare i canali di riconoscimento vocale e di telefonia DirectLine per assicurarsi che i tag SSML appropriati siano impostati nella proprietà Activity Speak.

CloudSkillHandler

Gestore di Bot Framework per le competenze.

SkillHandler
SkillHandlerImpl
SkillHttpClient

BotFrameworkHttpClient specializzato per competenze che incapsula la generazione dell'ID conversazione.

StatusCodeError

Estende l'errore per fornire messaggi di errore specializzati.

StreamingHttpClient

Implementazione di HttpClient che aggiunge compatibilità con le connessioni di streaming.

TokenResolver

Cerca OAuthCard negli allegati dell'attività e agisce su di essi

TeamsSSOTokenExchangeMiddleware

Se il nome dell'attività è signin/tokenExchange, questo middleware tenterà di scambiare il token e deduplicare la chiamata in ingresso, assicurando che venga elaborata una sola richiesta di scambio. Se un utente ha eseguito l'accesso a più client Teams, il bot potrebbe ricevere un "signin/tokenExchange" da ogni client. Ogni richiesta di scambio di token per un account di accesso utente specifico avrà un activity.value.id identico.

Solo una di queste richieste di scambio di token deve essere elaborata dal bot. Gli altri restituiscono StatusCodes.PRECONDITION_FAILED. Per un bot distribuito nell'ambiente di produzione, è necessario che l'archiviazione distribuita garantisca l'elaborazione di un solo scambio di token. Questo middleware supporta l'archiviazione di CosmosDb disponibile in botbuilder-azure o MemoryStorage per lo sviluppo locale.

TeamsActivityHandler

Aggiunge il supporto per eventi e interazioni specifici di Microsoft Teams.

TeamsInfo

Fornisce metodi di utilità per gli eventi e le interazioni che si verificano all'interno di Microsoft Teams.

Interfacce

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer

Interfaccia che rappresenta un'applicazione Express o un server Restify.

ConnectorClientBuilder

Astrazione per compilare i client del connettore.

Request

Rappresenta un Node.js richiesta HTTP, incluso il set minimo di proprietà di utilizzo. Compatibile con Restify, Express e Node.js core http.

Response
WebRequest

Rappresenta un oggetto richiesta Express o Restify. Questa interfaccia supporta il framework e non deve essere chiamata direttamente per il codice.

WebResponse

Rappresenta un oggetto risposta Express o Restify. Questa interfaccia supporta il framework e non deve essere chiamata direttamente per il codice.

Alias tipo

RouteHandler

Funzioni

validateAndFixActivity(Activity)

Convalida un Activity e formatta i campi timestamp.

teamsGetChannelId(Activity)

Metodi helper attività per Teams.

teamsGetSelectedChannelId(Activity)

Ottiene l'ID canale selezionato del team dall'attività corrente.

teamsGetTeamId(Activity)

Ottiene l'ID del team dall'attività di corrente.

teamsGetTeamInfo(Activity)

Ottiene l'oggetto TeamsInfo dall'Activity corrente.

teamsGetTeamMeetingInfo(Activity)

Ottiene l'oggetto TeamsMeetingInfo dall'attività corrente.

teamsGetTenant(Activity)

Ottiene l'oggetto TenantInfo dall'Activity corrente.

teamsNotifyUser(Partial<Activity>, boolean, string)

Configura il attività corrente per generare una notifica all'interno di Teams.

Dettagli funzione

validateAndFixActivity(Activity)

Convalida un Activity e formatta i campi timestamp.

function validateAndFixActivity(activity: Activity): Activity

Parametri

activity

Activity

(xref:botbuilder-core. Attività) da convalidare.

Restituisce

Activity

L'attività .

teamsGetChannelId(Activity)

Metodi helper attività per Teams.

function teamsGetChannelId(activity: Activity): string | null

Parametri

activity

Activity

L'attività corrente.

Restituisce

string | null

L'ID canale del team corrente activityo null.

teamsGetSelectedChannelId(Activity)

Ottiene l'ID canale selezionato del team dall'attività corrente.

function teamsGetSelectedChannelId(activity: Activity): string

Parametri

activity

Activity

L'attività corrente.

Restituisce

string

Canale selezionato del team dell'attività corrente o stringa vuota.

teamsGetTeamId(Activity)

Ottiene l'ID del team dall'attività di corrente.

function teamsGetTeamId(activity: Activity): string | null

Parametri

activity

Activity

L'attività corrente.

Restituisce

string | null

L'ID del team corrente attivitào null.

teamsGetTeamInfo(Activity)

Ottiene l'oggetto TeamsInfo dall'Activity corrente.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Parametri

activity

Activity

L'attività corrente.

Restituisce

TeamInfo | null

L'attività correnteinformazioni del team o null.

teamsGetTeamMeetingInfo(Activity)

Ottiene l'oggetto TeamsMeetingInfo dall'attività corrente.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Parametri

activity

Activity

L'attività corrente.

Restituisce

TeamsMeetingInfo | null

L'attività correnteinformazioni sulla riunione del team o null.

teamsGetTenant(Activity)

Ottiene l'oggetto TenantInfo dall'Activity corrente.

function teamsGetTenant(activity: Activity): TenantInfo | null

Parametri

activity

Activity

L'attività corrente.

Restituisce

TenantInfo | null

L'attività correnteinformazioni sul tenant o null.

teamsNotifyUser(Partial<Activity>, boolean, string)

Configura il attività corrente per generare una notifica all'interno di Teams.

function teamsNotifyUser(activity: Partial<Activity>, alertInMeeting?: boolean, externalResourceUrl?: string)

Parametri

activity

Partial<Activity>

L'attività corrente.

alertInMeeting

boolean

Inviato a una chat di riunione, il client di Teams lo eseguirà in un popup di notifica e nel thread di chat.

externalResourceUrl

string

URL della risorsa esterna. Deve essere incluso nei domini validi del manifesto.