Partager via

CloudAdapterBase class

  • Référence
Paquet:
botbuilder-core

Adaptateur qui implémente le protocole Bot Framework et peut être hébergé dans différents environnements cloud à la fois publics et privés.

Extends
BotAdapter

Constructeurs

CloudAdapterBase(BotFrameworkAuthentication)

Créez une instance CloudAdapterBase.

Propriétés

ConnectorFactoryKey
onTurnError

Obtient ou définit un gestionnaire d’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application. Définit un gestionnaire d’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application.
UserTokenClientKey

Propriétés héritées

BotIdentityKey
ConnectorClientKey
OAuthScopeKey

Méthodes

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)
continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>)
createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>)
deleteActivity(TurnContext, Partial<ConversationReference>)
sendActivities(TurnContext, Partial<Activity>[])
updateActivity(TurnContext, Partial<Activity>)

Méthodes héritées

use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Ajoute un intergiciel au pipeline de l’adaptateur.

Détails du constructeur

CloudAdapterBase(BotFrameworkAuthentication)

Créez une instance CloudAdapterBase.

new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)

Paramètres

botFrameworkAuthentication

BotFrameworkAuthentication

Une BotFrameworkAuthentication utilisée pour valider et créer des jetons.

Détails de la propriété

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Valeur de propriété

symbol

onTurnError

Obtient ou définit un gestionnaire d’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application. Définit un gestionnaire d’erreurs qui peut intercepter des exceptions dans l’intergiciel ou l’application.

(context: TurnContext, error: Error) => Promise<void> onTurnError

Valeur de propriété

(context: TurnContext, error: Error) => Promise<void>

Promesse représentant l’opération asynchrone.

Remarques

Le gestionnaire d’erreurs est appelé avec ces paramètres :

Nom Type Description
context TurnContext Objet de contexte pour le tour.
error Error Erreur Node.js levée.

UserTokenClientKey 

UserTokenClientKey: symbol

Valeur de propriété

symbol

Détails de la propriété héritée

BotIdentityKey 

BotIdentityKey: symbol

Valeur de propriété

symbol

héritée deBotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Valeur de propriété

symbol

héritée deBotAdapter.ConnectorClientKey

OAuthScopeKey 

OAuthScopeKey: symbol

Valeur de propriété

symbol

héritée deBotAdapter.OAuthScopeKey

Détails de la méthode

continueConversation(Partial<ConversationReference>, (context: TurnContext) => Promise<void>)

Avertissement

Cette API est à présent déconseillée.

function continueConversation(_reference: Partial<ConversationReference>, _logic: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

Retours

Promise<void>

continueConversationAsync(string | ClaimsIdentity, Partial<ConversationReference>, (context: TurnContext) => Promise<void> | string, (context: TurnContext) => Promise<void>) 

function continueConversationAsync(botAppIdOrClaimsIdentity: string | ClaimsIdentity, reference: Partial<ConversationReference>, logicOrAudience: (context: TurnContext) => Promise<void> | string, maybeLogic?: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

(context: TurnContext) => Promise<void> | string

maybeLogic

(context: TurnContext) => Promise<void>

Retours

Promise<void>

createConversationAsync(string, string, string, string, ConversationParameters, (context: TurnContext) => Promise<void>) 

function createConversationAsync(botAppId: string, channelId: string, serviceUrl: string, audience: string, conversationParameters: ConversationParameters, logic: (context: TurnContext) => Promise<void>): Promise<void>

Paramètres

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

Retours

Promise<void>

deleteActivity(TurnContext, Partial<ConversationReference>) 

function deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void>

Paramètres

context
TurnContext
reference

Partial<ConversationReference>

Retours

Promise<void>

sendActivities(TurnContext, Partial<Activity>[]) 

function sendActivities(context: TurnContext, activities: Partial<Activity>[]): Promise<ResourceResponse[]>

Paramètres

context
TurnContext
activities

Partial<Activity>[]

Retours

Promise<ResourceResponse[]>

updateActivity(TurnContext, Partial<Activity>) 

function updateActivity(context: TurnContext, activity: Partial<Activity>): Promise<ResourceResponse | void>

Paramètres

context
TurnContext
activity

Partial<Activity>

Retours

Promise<ResourceResponse | void>

Détails de la méthode héritée

use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Ajoute un intergiciel au pipeline de l’adaptateur.

function use(middlewares: (context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]): this

Paramètres

middlewares

(context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[]

Les gestionnaires d’intergiciels ou d’intergiciels à ajouter.

Retours

this

Objet adaptateur mis à jour.

Remarques

L’intergiciel est ajouté à l’adaptateur au moment de l’initialisation. Chaque tour, l’adaptateur appelle son intergiciel dans l’ordre dans lequel vous l’avez ajouté.

héritée deBotAdapter.use