Compartilhar via

botbuilder package

  • Referência

Classes

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase

O ChannelServiceHandlerBase implementa a API para encaminhar a atividade para uma habilidade e implementa o roteamento de chamadas ChannelAPI do Skill por meio do bot/adaptador.
ChannelServiceRoutes

Roteia as chamadas à API com os métodos ChannelServiceHandler.
CloudAdapter

Um adaptador que implementa o Protocolo bot framework e pode ser hospedado em ambientes de nuvem diferentes, tanto públicos quanto privados.
CloudChannelServiceHandler

Uma classe para ajudar na implementação do protocolo Bot Framework usando botFrameworkAuthentication.
EventFactory

Contém métodos utilitários para criar vários tipos de evento.
FileTranscriptStore

O repositório de transcrição de arquivos armazena transcrições no sistema de arquivos com cada atividade como um arquivo.
HandoffEventNames

Define valores para nomes de eventos de entrega.
InspectionMiddleware

InspectionMiddleware para inspeção do emulador de atividades de runtime e BotState.
InspectionState

InspectionState para uso pelo InspectionMiddleware para inspeção do emulador de atividades de runtime e BotState.
RouteConstants

Constantes que representam o caminho da API que segue imediatamente o basePath. No momento, elas são internas, mas vamos reavaliar o fato de torná-las públicas no futuro.

exemplo

RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.
SetSpeakMiddleware

Dê suporte aos canais de fala e telefonia do DirectLine para garantir que as marcas SSML apropriadas sejam definidas na propriedade Activity Speak.
CloudSkillHandler

Um Manipulador do Bot Framework para habilidades.
SkillHandler
SkillHandlerImpl
SkillHttpClient

Um BotFrameworkHttpClient especializado em Habilidades que encapsula a geração de ID de Conversa.
StatusCodeError

Estende o Erro para fornecer mensagens de erro especializadas.
StreamingHttpClient

Uma implementação de HttpClient que adiciona compatibilidade com conexões de streaming.
TokenResolver

Procura por OAuthCards em anexos de atividade e toma medidas sobre eles
TeamsSSOTokenExchangeMiddleware

Se o nome da atividade for signin/tokenExchange, esse middleware tentará trocar o token e deduplicar a chamada de entrada, garantindo que apenas uma solicitação de troca seja processada. Se um usuário estiver conectado a vários clientes do Teams, o Bot poderá receber uma "conexão/tokenExchange" de cada cliente. Cada solicitação de troca de token para um logon de usuário específico terá uma activity.value.id idêntica.

Apenas uma dessas solicitações de troca de tokens deve ser processada pelo bot. Os outros retornam StatusCodes.PRECONDITION_FAILED. Para um bot distribuído em produção, isso requer armazenamento distribuído garantindo que apenas uma troca de tokens seja processada. Esse middleware dá suporte ao armazenamento do CosmosDb encontrado no botbuilder-azure ou no MemoryStorage para desenvolvimento local.
TeamsActivityHandler

Adiciona suporte para eventos e interações específicos do Microsoft Teams.
TeamsInfo

Fornece métodos utilitários para os eventos e interações que ocorrem no Microsoft Teams.

Interfaces

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer

Interface que representa um Aplicativo Expresso ou um Servidor Restify.
ConnectorClientBuilder

Abstração para criar clientes conectores.
Request

Representa um Node.js solicitação HTTP, incluindo o conjunto mínimo de propriedades de uso. Compatível com Restify, Express e Node.js http principal.
Response
WebRequest

Representa um objeto de solicitação Express ou Restify. Essa interface dá suporte à estrutura e não se destina a ser chamada diretamente para seu código.
WebResponse

Representa um objeto de resposta Express ou Restify. Essa interface dá suporte à estrutura e não se destina a ser chamada diretamente para seu código.

Aliases de tipo

RouteHandler

Funções

validateAndFixActivity(Activity)

Valida uma atividade de e formata os campos de carimbo de data/hora.
teamsGetChannelId(Activity)

Métodos auxiliares de atividade para o Teams.
teamsGetSelectedChannelId(Activity)

Obtém a ID de canal selecionada da equipe da atividade atual.
teamsGetTeamId(Activity)

Obtém a ID da equipe dode Atividade do atual.
teamsGetTeamInfo(Activity)

Obtém o objeto TeamsInfo dode Atividade do atual.
teamsGetTeamMeetingInfo(Activity)

Obtém o objeto TeamsMeetingInfo dode Atividade do atual.
teamsGetTenant(Activity)

Obtém o objeto TenantInfo dode Atividade do atual.
teamsNotifyUser(Partial<Activity>, boolean, string)

Configura o de Atividade de atual para gerar uma notificação no Teams.

Detalhes da função

validateAndFixActivity(Activity)

Valida uma atividade de e formata os campos de carimbo de data/hora.

function validateAndFixActivity(activity: Activity): Activity

Parâmetros

activity

Activity

(xref:botbuilder-core. Atividade) a ser validada.

Retornos

Activity

A atividade de .

teamsGetChannelId(Activity)

Métodos auxiliares de atividade para o Teams.

function teamsGetChannelId(activity: Activity): string | null

Parâmetros

activity

Activity

A atividade de atual.

Retornos

string | null

A atividade de atuala ID do canal da equipe ou nula.

teamsGetSelectedChannelId(Activity)

Obtém a ID de canal selecionada da equipe da atividade atual.

function teamsGetSelectedChannelId(activity: Activity): string

Parâmetros

activity

Activity

A atividade de atual.

Retornos

string

O canal selecionado da equipe da atividade atual ou a cadeia de caracteres vazia.

teamsGetTeamId(Activity)

Obtém a ID da equipe dode Atividade do atual.

function teamsGetTeamId(activity: Activity): string | null

Parâmetros

activity

Activity

A atividade de atual.

Retornos

string | null

A atividade de atualid da equipe ou nula.

teamsGetTeamInfo(Activity)

Obtém o objeto TeamsInfo dode Atividade do atual.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Parâmetros

activity

Activity

A atividade de atual.

Retornos

TeamInfo | null

A atividade de atualinformações da equipe ou nula.

teamsGetTeamMeetingInfo(Activity)

Obtém o objeto TeamsMeetingInfo dode Atividade do atual.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Parâmetros

activity

Activity

A atividade de atual.

Retornos

TeamsMeetingInfo | null

A atividade de atualinformações de reunião de equipe ou nulas.

teamsGetTenant(Activity)

Obtém o objeto TenantInfo dode Atividade do atual.

function teamsGetTenant(activity: Activity): TenantInfo | null

Parâmetros

activity

Activity

A atividade de atual.

Retornos

TenantInfo | null

A atividade de atualinformações de locatário ou nulas.

teamsNotifyUser(Partial<Activity>, boolean, string)

Configura o de Atividade de atual para gerar uma notificação no Teams.

function teamsNotifyUser(activity: Partial<Activity>, alertInMeeting?: boolean, externalResourceUrl?: string)

Parâmetros

activity

Partial<Activity>

A atividade de atual.

alertInMeeting

boolean

Enviado para um chat de reunião, isso fará com que o cliente do Teams o renderize em um pop-up de notificação, bem como no thread de chat.

externalResourceUrl

string

Url para recurso externo. Deve ser incluído nos domínios válidos do manifesto.