Freigeben über

CloudAdapterBase class

  • Referenz
Paket:
botbuilder-core

Ein Adapter, der das Bot Framework-Protokoll implementiert und in verschiedenen Cloudumgebungen sowohl öffentlich als auch privat gehostet werden kann.

Extends
BotAdapter

Konstruktoren

CloudAdapterBase(BotFrameworkAuthentication)

Erstellen Sie eine neue CloudAdapterBase Instanz.

Eigenschaften

ConnectorFactoryKey
onTurnError

Dient zum Abrufen oder Festlegen eines Fehlerhandlers, der Ausnahmen in der Middleware oder Anwendung abfangen kann. Legt einen Fehlerhandler fest, der Ausnahmen in der Middleware oder Anwendung abfangen kann.
UserTokenClientKey

Geerbte Eigenschaften

BotIdentityKey
ConnectorClientKey
OAuthScopeKey

Methoden

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>)

Geerbte Methoden

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

Fügt Middleware zur Pipeline des Adapters hinzu.

Details zum Konstruktor

CloudAdapterBase(BotFrameworkAuthentication)

Erstellen Sie eine neue CloudAdapterBase Instanz.

new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)

Parameter

botFrameworkAuthentication

BotFrameworkAuthentication

Eine BotFrameworkAuthentication zum Überprüfen und Erstellen von Token verwendet.

Details zur Eigenschaft

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Eigenschaftswert

symbol

onTurnError

Dient zum Abrufen oder Festlegen eines Fehlerhandlers, der Ausnahmen in der Middleware oder Anwendung abfangen kann. Legt einen Fehlerhandler fest, der Ausnahmen in der Middleware oder Anwendung abfangen kann.

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

Eigenschaftswert

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

Eine Zusage, die den asynchronen Vorgang darstellt.

Hinweise

Der Fehlerhandler wird mit folgenden Parametern aufgerufen:

Name Art Beschreibung
context TurnContext- Das Kontextobjekt für die Drehung.
error Error Der Node.js Fehler ausgelöst.

UserTokenClientKey 

UserTokenClientKey: symbol

Eigenschaftswert

symbol

Geerbte Eigenschaftsdetails

BotIdentityKey 

BotIdentityKey: symbol

Eigenschaftswert

symbol

vonBotAdapter.BotIdentityKey geerbt

ConnectorClientKey 

ConnectorClientKey: symbol

Eigenschaftswert

symbol

geerbt vonBotAdapter.ConnectorClientKey

OAuthScopeKey 

OAuthScopeKey: symbol

Eigenschaftswert

symbol

vonBotAdapter.OAuthScopeKey

Details zur Methode

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

Warnung

Diese API ist nun veraltet.

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

Parameter

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

Gibt zurück

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>

Parameter

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

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

maybeLogic

(context: TurnContext) => Promise<void>

Gibt zurück

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>

Parameter

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

Gibt zurück

Promise<void>

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Parameter

context
TurnContext
reference

Partial<ConversationReference>

Gibt zurück

Promise<void>

sendActivities(TurnContext, Partial<Activity>[]) 

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

Parameter

context
TurnContext
activities

Partial<Activity>[]

Gibt zurück

Promise<ResourceResponse[]>

updateActivity(TurnContext, Partial<Activity>) 

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

Parameter

context
TurnContext
activity

Partial<Activity>

Gibt zurück

Promise<ResourceResponse | void>

Details zur geerbten Methode

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

Fügt Middleware zur Pipeline des Adapters hinzu.

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

Parameter

middlewares

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

Die hinzuzufügenden Middleware- oder Middleware-Handler.

Gibt zurück

this

Das aktualisierte Adapterobjekt.

Hinweise

Middleware wird dem Adapter zur Initialisierungszeit hinzugefügt. Jeder Turn ruft die Middleware des Adapters in der Reihenfolge auf, in der Sie ihn hinzugefügt haben.

Geerbt vonBotAdapter.use