CloudAdapterBase class

  • Riferimento
Pacchetto:
botbuilder-core

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

Extends
BotAdapter

Costruttori

CloudAdapterBase(BotFrameworkAuthentication)

Creare una nuova istanza di CloudAdapterBase.

Proprietà

ConnectorFactoryKey
onTurnError

Ottiene o imposta un gestore errori che può intercettare le eccezioni nel middleware o nell'applicazione. Imposta un gestore errori in grado di intercettare le eccezioni nel middleware o nell'applicazione.
UserTokenClientKey

Proprietà ereditate

BotIdentityKey
ConnectorClientKey
OAuthScopeKey

Metodi

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

Metodi ereditati

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

Aggiunge middleware alla pipeline dell'adapter.

Dettagli costruttore

CloudAdapterBase(BotFrameworkAuthentication)

Creare una nuova istanza di CloudAdapterBase.

new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)

Parametri

botFrameworkAuthentication

BotFrameworkAuthentication

Un BotFrameworkAuthentication usato per la convalida e la creazione di token.

Dettagli proprietà

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Valore della proprietà

symbol

onTurnError

Ottiene o imposta un gestore errori che può intercettare le eccezioni nel middleware o nell'applicazione. Imposta un gestore errori in grado di intercettare le eccezioni nel middleware o nell'applicazione.

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

Valore della proprietà

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

Promessa che rappresenta l'operazione asincrona.

Commenti

Il gestore degli errori viene chiamato con questi parametri:

Nome Digitare Descrizione
context TurnContext Oggetto di contesto per il turno.
error Error Errore Node.js generato.

UserTokenClientKey 

UserTokenClientKey: symbol

Valore della proprietà

symbol

Dettagli proprietà ereditate

BotIdentityKey 

BotIdentityKey: symbol

Valore della proprietà

symbol

ereditato daBotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Valore della proprietà

symbol

ereditato daBotAdapter.ConnectorClientKey

OAuthScopeKey 

OAuthScopeKey: symbol

Valore della proprietà

symbol

ereditato daBotAdapter.OAuthScopeKey

Dettagli metodo

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>

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>

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>

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Parametri

context
TurnContext
reference

Partial<ConversationReference>

Restituisce

Promise<void>

sendActivities(TurnContext, Partial<Activity>[]) 

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

Parametri

context
TurnContext
activities

Partial<Activity>[]

Restituisce

Promise<ResourceResponse[]>

updateActivity(TurnContext, Partial<Activity>) 

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

Parametri

context
TurnContext
activity

Partial<Activity>

Restituisce

Promise<ResourceResponse | void>

Dettagli dei metodi ereditati

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 daBotAdapter.use