CloudAdapterBase class
Ein Adapter, der das Bot Framework-Protokoll implementiert und in verschiedenen öffentlichen und privaten Cloudumgebungen gehostet werden kann.
- Extends
Konstruktoren
Cloud |
Erstellen Sie eine neue CloudAdapterBase-Instanz . |
Eigenschaften
Connector |
|
on |
Ruft einen Fehlerhandler ab, der Ausnahmen in der Middleware oder Anwendung abfangen kann, oder legt diesen fest. Legt einen Fehlerhandler fest, der Ausnahmen in der Middleware oder Anwendung abfangen kann. |
User |
Geerbte Eigenschaften
Bot |
|
Connector |
|
OAuth |
Methoden
Geerbte Methoden
use((context: Turn |
Fügt der Pipeline des Adapters Middleware hinzu. |
Details zum Konstruktor
CloudAdapterBase(BotFrameworkAuthentication)
Erstellen Sie eine neue CloudAdapterBase-Instanz .
new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)
Parameter
- botFrameworkAuthentication
-
BotFrameworkAuthentication
Eine BotFrameworkAuthentication, die zum Überprüfen und Erstellen von Token verwendet wird.
Details zur Eigenschaft
ConnectorFactoryKey
ConnectorFactoryKey: symbol
Eigenschaftswert
symbol
onTurnError
Ruft einen Fehlerhandler ab, der Ausnahmen in der Middleware oder Anwendung abfangen kann, oder legt diesen fest. 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 den folgenden Parametern aufgerufen:
Name | type | BESCHREIBUNG |
---|---|---|
context |
TurnContext | Das Kontextobjekt für den Turn. |
error |
Error |
Der Node.js fehler ausgelöst. |
UserTokenClientKey
UserTokenClientKey: symbol
Eigenschaftswert
symbol
Geerbte Eigenschaftsdetails
BotIdentityKey
ConnectorClientKey
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 der Pipeline des Adapters Middleware 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 Middlewarehandler.
Gibt zurück
this
Das aktualisierte Adapterobjekt.
Hinweise
Middleware wird dem Adapter zur Initialisierungszeit hinzugefügt. Bei jedem Turn ruft der Adapter seine Middleware in der Reihenfolge auf, in der Sie sie hinzugefügt haben.
Geerbt vonBotAdapter.use