botbuilder package

Classes

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase	ChannelServiceHandlerBase implémente l’API pour transférer l’activité vers une compétence et implémente le routage des appels ChannelAPI à partir de la compétence via le bot/adaptateur.
ChannelServiceRoutes	Route les appels d’API avec les méthodes ChannelServiceHandler.
CloudAdapter	Adaptateur qui implémente le protocole Bot Framework et peut être hébergé dans différents environnements cloud à la fois publics et privés.
CloudChannelServiceHandler	Classe permettant d’aider à implémenter le protocole Bot Framework à l’aide de BotFrameworkAuthentication.
EventFactory	Contient des méthodes utilitaires pour créer différents types d’événements.
FileTranscriptStore	Le magasin de transcriptions de fichiers stocke les transcriptions dans le système de fichiers avec chaque activité en tant que fichier.
HandoffEventNames	Définit des valeurs pour les noms d’événements de transfert.
InspectionMiddleware	InspectionMiddleware pour l’inspection de l’émulateur des activités d’exécution et botState.
InspectionState	InspectionState à utiliser par InspectionMiddleware pour l’inspection de l’émulateur des activités d’exécution et botState.
RouteConstants	Constantes représentant le chemin d’accès de l’API qui suit immédiatement le chemin d’accès basePath. Ceux-ci sont actuellement internes, mais nous allons les réévaluer en les rendant publics, à l’avenir. exemple de RouteConstants.Activities = '/v3/conversations/ :conversationId/activities'.
SetSpeakMiddleware	Prenez en charge les canaux de reconnaissance vocale et de téléphonie DirectLine pour vous assurer que les balises SSML appropriées sont définies sur la propriété Activity Speak.
CloudSkillHandler	Gestionnaire Bot Framework pour les compétences.
SkillHandler
SkillHandlerImpl
SkillHttpClient	BotFrameworkHttpClient spécialisé pour skills qui encapsule la génération d’ID de conversation.
StatusCodeError	Étend l’erreur pour fournir des messages d’erreur spécialisés.
StreamingHttpClient	Implémentation de HttpClient qui ajoute la compatibilité avec les connexions de streaming.
TokenResolver	Recherche les cartes OAuthCard dans les pièces jointes d’activité et prend des mesures sur celles-ci
TeamsSSOTokenExchangeMiddleware	Si le nom de l’activité est signin/tokenExchange, cet intergiciel tente d’échanger le jeton et déduplique l’appel entrant, ce qui garantit qu’une seule demande d’échange est traitée. Si un utilisateur est connecté à plusieurs clients Teams, le bot peut recevoir un « signin/tokenExchange » de chaque client. Chaque demande d’échange de jetons pour une connexion utilisateur spécifique aura une activity.value.id identique. Une seule de ces demandes d’échange de jetons doit être traitée par le bot. Les autres retournent StatusCodes.PRECONDITION_FAILED. Pour un bot distribué en production, cela nécessite un stockage distribué s’assurant qu’un seul échange de jetons est traité. Ce middleware prend en charge le stockage CosmosDb trouvé dans botbuilder-azure ou MemoryStorage pour le développement local.
TeamsActivityHandler	Ajoute la prise en charge des événements et interactions spécifiques à Microsoft Teams.
TeamsInfo	Fournit des méthodes utilitaires pour les événements et les interactions qui se produisent dans Microsoft Teams.

Interfaces

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer	Interface représentant une application Express ou un serveur Restify.
ConnectorClientBuilder	Abstraction pour générer des clients de connecteur.
Request	Représente une requête HTTP Node.js, y compris le jeu minimal de propriétés d’utilisation. Compatible avec Restify, Express et Node.js core http.
Response
WebRequest	Représente un objet de requête Express ou Restify. Cette interface prend en charge l’infrastructure et n’est pas destinée à être appelée directement pour votre code.
WebResponse	Représente un objet de réponse Express ou Restify. Cette interface prend en charge l’infrastructure et n’est pas destinée à être appelée directement pour votre code.

Alias de type

RouteHandler

Functions

validateAndFixActivity(Activity)	Valide un Activité et met en forme les champs d’horodatage.
teamsGetChannelId(Activity)	Méthodes d’assistance d’activité pour Teams.
teamsGetSelectedChannelId(Activity)	Obtient l’ID de canal sélectionné de l’équipe à partir de l’activité actuelle.
teamsGetTeamId(Activity)	Obtient l’ID d’équipe dud’activité actuel.
teamsGetTeamInfo(Activity)	Obtient l’objet TeamsInfo de l'activité actuelle.
teamsGetTeamMeetingInfo(Activity)	Obtient l’objet TeamsMeetingInfo à partir dud’activité actuel.
teamsGetTenant(Activity)	Obtient l’objet TenantInfo de l'activité actuelle.
teamsNotifyUser(Partial<Activity>, boolean, string)	Configure le d’activité actuel pour générer une notification dans Teams.

Informations relatives à la fonction

validateAndFixActivity(Activity)

Valide un Activité et met en forme les champs d’horodatage.

function validateAndFixActivity(activity: Activity): Activity

Paramètres

activity

Activity

(xref :botbuilder-core. Activité) à valider.

Retours

Activity

d’activité .

teamsGetChannelId(Activity)

Méthodes d’assistance d’activité pour Teams.

function teamsGetChannelId(activity: Activity): string | null

Paramètres

activity

Activity

L’activité actuelle.

Retours

string | null

L’activité actuelle'ID de canal de l’équipe ou null.

teamsGetSelectedChannelId(Activity)

Obtient l’ID de canal sélectionné de l’équipe à partir de l’activité actuelle.

function teamsGetSelectedChannelId(activity: Activity): string

Paramètres

activity

Activity

L’activité actuelle.

Retours

string

Canal sélectionné de l’équipe de l’activité actuelle ou chaîne vide.

teamsGetTeamId(Activity)

Obtient l’ID d’équipe dud’activité actuel.

function teamsGetTeamId(activity: Activity): string | null

Paramètres

activity

Activity

L’activité actuelle.

Retours

string | null

L’activité actuelle'ID de l’équipe ou null.

teamsGetTeamInfo(Activity)

Obtient l’objet TeamsInfo de l'activité actuelle.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Paramètres

activity

Activity

L’activité actuelle.

Retours

TeamInfo | null

L’activité actuelle'informations de l’équipe ou null.

teamsGetTeamMeetingInfo(Activity)

Obtient l’objet TeamsMeetingInfo à partir dud’activité actuel.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Paramètres

activity

Activity

L’activité actuelle.

Retours

TeamsMeetingInfo | null

L’activité actuelle'informations de réunion d’équipe', ou null.

teamsGetTenant(Activity)

Obtient l’objet TenantInfo de l'activité actuelle.

function teamsGetTenant(activity: Activity): TenantInfo | null

Paramètres

activity

Activity

L’activité actuelle.

Retours

TenantInfo | null

L’activité actuelle'informations sur le locataire ou null.

teamsNotifyUser(Partial<Activity>, boolean, string)

Configure le d’activité actuel pour générer une notification dans Teams.

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

Paramètres

activity

Partial<Activity>

L’activité actuelle.

alertInMeeting

boolean

Envoyé à une conversation de réunion, cela entraîne le rendu du client Teams dans une fenêtre contextuelle de notification, ainsi que dans le thread de conversation.

externalResourceUrl

string

URL vers une ressource externe. Doit être inclus dans les domaines valides du manifeste.