CloudAdapterBase class

  • Referência
Pacote:
botbuilder-core

Um adaptador que implementa o Protocolo do Bot Framework e pode ser hospedado em diferentes ambientes de nuvem públicos e privados.

Extends
BotAdapter

Construtores

CloudAdapterBase(BotFrameworkAuthentication)

Crie uma nova instância CloudAdapterBase.

Propriedades

ConnectorFactoryKey
onTurnError

Obtém ou define um manipulador de erros que pode capturar exceções no middleware ou aplicativo. Define um manipulador de erros que pode capturar exceções no middleware ou aplicativo.
UserTokenClientKey

Propriedades herdadas

BotIdentityKey
ConnectorClientKey
OAuthScopeKey

Métodos

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

Métodos herdados

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

Adiciona middleware ao pipeline do adaptador.

Detalhes do construtor

CloudAdapterBase(BotFrameworkAuthentication)

Crie uma nova instância CloudAdapterBase.

new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)

Parâmetros

botFrameworkAuthentication

BotFrameworkAuthentication

Um botFrameworkAuthentication usado para validar e criar tokens.

Detalhes da propriedade

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Valor da propriedade

symbol

onTurnError

Obtém ou define um manipulador de erros que pode capturar exceções no middleware ou aplicativo. Define um manipulador de erros que pode capturar exceções no middleware ou aplicativo.

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

Valor da propriedade

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

Uma promessa que representa a operação assíncrona.

Comentários

O manipulador de erros é chamado com estes parâmetros:

Nome Tipo Descrição
context TurnContext O objeto de contexto para a curva.
error Error O erro de Node.js gerado.

UserTokenClientKey 

UserTokenClientKey: symbol

Valor da propriedade

symbol

Detalhes das propriedades herdadas

BotIdentityKey 

BotIdentityKey: symbol

Valor da propriedade

symbol

herdado de BotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Valor da propriedade

symbol

herdado de BotAdapter.ConnectorClientKey

OAuthScopeKey 

OAuthScopeKey: symbol

Valor da propriedade

symbol

herdado de BotAdapter.OAuthScopeKey

Detalhes do método

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

Aviso

Essa API foi preterida.

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

Parâmetros

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

Retornos

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>

Parâmetros

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

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

maybeLogic

(context: TurnContext) => Promise<void>

Retornos

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>

Parâmetros

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

Retornos

Promise<void>

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Parâmetros

context
TurnContext
reference

Partial<ConversationReference>

Retornos

Promise<void>

sendActivities(TurnContext, Partial<Activity>[]) 

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

Parâmetros

context
TurnContext
activities

Partial<Activity>[]

Retornos

Promise<ResourceResponse[]>

updateActivity(TurnContext, Partial<Activity>) 

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

Parâmetros

context
TurnContext
activity

Partial<Activity>

Retornos

Promise<ResourceResponse | void>

Detalhes do método herdado

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

Adiciona middleware ao pipeline do adaptador.

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

Parâmetros

middlewares

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

Os manipuladores de middleware ou middleware a serem adicionados.

Retornos

this

O objeto do adaptador atualizado.

Comentários

O middleware é adicionado ao adaptador no momento da inicialização. A cada turno, o adaptador chama seu middleware na ordem em que você o adicionou.

Herdado doBotAdapter.use