Freigeben über

CloudAdapter class

  • Referenz
Paket:
botbuilder

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

Extends

CloudAdapterBase

Konstruktoren

CloudAdapter(BotFrameworkAuthentication)

Initialisiert eine neue Instanz der CloudAdapter Klasse.

Geerbte Eigenschaften

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

Methoden

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Wird verwendet, um den Adapter mit einem benannten Rohr zu verbinden.
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Behandeln Sie eine Websocketverbindung, indem Sie eine Logikfunktion auf jede Streaminganforderung anwenden.
process(Request, Response, (context: TurnContext) => Promise<void>)

Verarbeiten einer Webanforderung durch Anwenden einer Logikfunktion.

Geerbte 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>)
use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Fügt Middleware zur Pipeline des Adapters hinzu.

Details zum Konstruktor

CloudAdapter(BotFrameworkAuthentication)

Initialisiert eine neue Instanz der CloudAdapter Klasse.

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

Parameter

botFrameworkAuthentication

BotFrameworkAuthentication

Optionale BotFrameworkAuthentication Instanz

Geerbte Eigenschaftsdetails

BotIdentityKey 

BotIdentityKey: symbol

Eigenschaftswert

symbol

von BotAdapter.BotIdentityKey geerbt

ConnectorClientKey 

ConnectorClientKey: symbol

Eigenschaftswert

symbol

von BotAdapter.ConnectorClientKey geerbt

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Eigenschaftswert

symbol

von CloudAdapterBase.ConnectorFactoryKey geerbt

OAuthScopeKey 

OAuthScopeKey: symbol

Eigenschaftswert

symbol

von BotAdapter.OAuthScopeKey geerbt

onTurnError 

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

Eigenschaftswert

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

von BotAdapter.onTurnError geerbt

UserTokenClientKey 

UserTokenClientKey: symbol

Eigenschaftswert

symbol

von CloudAdapterBase.UserTokenClientKey geerbt

Details zur Methode

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Wird verwendet, um den Adapter mit einem benannten Rohr zu verbinden.

function connectNamedPipe(pipeName: string, logic: (context: TurnContext) => Promise<void>, appId: string, audience: string, callerId?: string, retryCount?: number): Promise<void>

Parameter

pipeName

string

Pipename to connect to (note: yields two named pipe servers by appending ".incoming" and ".outgoing" to this name)

logic

(context: TurnContext) => Promise<void>

Die Logikfunktion, die für den aufrufenden Bot aufgerufen werden soll, wird gedreht.

appId

string

Die Bot-Anwendungs-ID

audience

string

Die Zielgruppe, die für ausgehende Kommunikation verwendet werden soll. Dies variiert je nach Cloudumgebung.

callerId

string

Optional, die Anrufer-ID

retryCount

number

Optional, die Anzahl der Wiederholungen einer fehlgeschlagenen Verbindung (Standardwert 7)

Gibt zurück

Promise<void>

process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Behandeln Sie eine Websocketverbindung, indem Sie eine Logikfunktion auf jede Streaminganforderung anwenden.

function process(req: Request, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parameter

req
Request

Ein eingehender HTTP-Anforderungs-

socket

INodeSocket

Das entsprechende INodeSocket-

head

INodeBuffer

Die entsprechende INodeBuffer-

logic

(context: TurnContext) => Promise<void>

Die anzuwendende Logikfunktion

Gibt zurück

Promise<void>

eine Zusage, die den asynchronen Vorgang darstellt.

process(Request, Response, (context: TurnContext) => Promise<void>)

Verarbeiten einer Webanforderung durch Anwenden einer Logikfunktion.

function process(req: Request, res: Response, logic: (context: TurnContext) => Promise<void>): Promise<void>

Parameter

req
Request

Die entsprechende HTTP--Antwort-

res
Response
logic

(context: TurnContext) => Promise<void>

Die anzuwendende Logikfunktion

Gibt zurück

Promise<void>

eine Zusage, die den asynchronen Vorgang darstellt.

Details zur geerbten 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>

Geerbt von CloudAdapterBase.continueConversation

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>

Geerbt von CloudAdapterBase.continueConversationAsync

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>

geerbt von CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Parameter

context

TurnContext

reference

Partial<ConversationReference>

Gibt zurück

Promise<void>

Geerbt von CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[]) 

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

Parameter

context

TurnContext

activities

Partial<Activity>[]

Gibt zurück

Promise<ResourceResponse[]>

geerbt von CloudAdapterBase.sendActivities

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>

Von CloudAdapterBase.updateActivity geerbt

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.

von BotAdapter.use geerbt