Condividi tramite

CloudAdapter class

  • Riferimento
Pacchetto:
botbuilder

Adattatore che implementa il protocollo Bot Framework e può essere ospitato in ambienti cloud diversi sia pubblici che privati.

Extends

CloudAdapterBase

Costruttori

CloudAdapter(BotFrameworkAuthentication)

Inizializza una nuova istanza della classe CloudAdapter.

Proprietà ereditate

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

Metodi

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

Consente di connettere l'adattatore a una named pipe.
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Gestire una connessione Web Socket applicando una funzione logica a ogni richiesta di streaming.
process(Request, Response, (context: TurnContext) => Promise<void>)

Elaborare una richiesta Web applicando una funzione logica.

Metodi ereditati

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

Aggiunge middleware alla pipeline dell'adapter.

Dettagli costruttore

CloudAdapter(BotFrameworkAuthentication)

Inizializza una nuova istanza della classe CloudAdapter.

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

Parametri

botFrameworkAuthentication

BotFrameworkAuthentication

Istanza facoltativa BotFrameworkAuthentication

Dettagli proprietà ereditate

BotIdentityKey 

BotIdentityKey: symbol

Valore della proprietà

symbol

ereditato da BotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Valore della proprietà

symbol

ereditato da BotAdapter.ConnectorClientKey

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Valore della proprietà

symbol

ereditato da CloudAdapterBase.ConnectorFactoryKey

OAuthScopeKey 

OAuthScopeKey: symbol

Valore della proprietà

symbol

ereditato da BotAdapter.OAuthScopeKey

onTurnError 

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

Valore della proprietà

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

Ereditato da BotAdapter.onTurnError

UserTokenClientKey 

UserTokenClientKey: symbol

Valore della proprietà

symbol

ereditato da CloudAdapterBase.UserTokenClientKey

Dettagli metodo

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

Consente di connettere l'adattatore a una named pipe.

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

Parametri

pipeName

string

Nome pipe a cui connettersi (nota: restituisce due server named pipe aggiungendo ".incoming" e ".outgoing" a questo nome)

logic

(context: TurnContext) => Promise<void>

La funzione logica da chiamare per i turni del bot risultante.

appId

string

ID applicazione bot

audience

string

Destinatari da usare per le comunicazioni in uscita. La variabile varia in base all'ambiente cloud.

callerId

string

Facoltativo, ID chiamante

retryCount

number

Facoltativo, numero di tentativi di connessione non riuscita (il valore predefinito è 7)

Restituisce

Promise<void>

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

Gestire una connessione Web Socket applicando una funzione logica a ogni richiesta di streaming.

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

Parametri

req
Request

Una richiesta http in ingresso

socket

INodeSocket

INodeSocket corrispondente

head

INodeBuffer

INodeBuffer corrispondente

logic

(context: TurnContext) => Promise<void>

Funzione logica da applicare

Restituisce

Promise<void>

promessa che rappresenta l'operazione asincrona.

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

Elaborare una richiesta Web applicando una funzione logica.

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

Parametri

req
Request

di risposta HTTP corrispondente

res
Response
logic

(context: TurnContext) => Promise<void>

Funzione logica da applicare

Restituisce

Promise<void>

promessa che rappresenta l'operazione asincrona.

Dettagli dei metodi ereditati

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

Avviso

Questa API è ora deprecata.

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

Parametri

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

Restituisce

Promise<void>

ereditato da 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>

Parametri

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

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

maybeLogic

(context: TurnContext) => Promise<void>

Restituisce

Promise<void>

Ereditato da 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>

Parametri

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

Restituisce

Promise<void>

Ereditato da CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Parametri

context

TurnContext

reference

Partial<ConversationReference>

Restituisce

Promise<void>

Ereditato da CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[]) 

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

Parametri

context

TurnContext

activities

Partial<Activity>[]

Restituisce

Promise<ResourceResponse[]>

ereditato da CloudAdapterBase.sendActivities

updateActivity(TurnContext, Partial<Activity>) 

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

Parametri

context

TurnContext

activity

Partial<Activity>

Restituisce

Promise<ResourceResponse | void>

ereditato da CloudAdapterBase.updateActivity

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

Aggiunge middleware alla pipeline dell'adapter.

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

Parametri

middlewares

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

Gestori middleware o middleware da aggiungere.

Restituisce

this

Oggetto adapter aggiornato.

Commenti

Il middleware viene aggiunto all'adapter in fase di inizializzazione. Ogni turno, l'adattatore chiama il middleware nell'ordine in cui è stato aggiunto.

Ereditato da BotAdapter.use