botbuilder package

Clases

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase	ChannelServiceHandlerBase implementa la API para reenviar la actividad a una aptitud e implementa el enrutamiento de llamadas ChannelAPI desde la aptitud hasta el bot o adaptador.
ChannelServiceRoutes	Enruta las llamadas API con los métodos ChannelServiceHandler.
CloudAdapter	Un adaptador que implementa bot Framework Protocol y se puede hospedar en entornos de nube diferentes tanto públicos como privados.
CloudChannelServiceHandler	Clase que ayuda con la implementación del protocolo bot Framework mediante BotFrameworkAuthentication.
EventFactory	Contiene métodos de utilidad para crear varios tipos de eventos.
FileTranscriptStore	El almacén de transcripciones de archivos almacena transcripciones en el sistema de archivos con cada actividad como un archivo.
HandoffEventNames	Define valores para los nombres de eventos de entrega.
InspectionMiddleware	InspectionMiddleware para la inspección del emulador de actividades en tiempo de ejecución y BotState.
InspectionState	InspectionState para su uso en InspectionMiddleware para la inspección del emulador de actividades en tiempo de ejecución y BotState.
RouteConstants	Constantes que representan la ruta de acceso de la API que sigue inmediatamente a basePath. Estos son actualmente internos, pero los volveremos a evaluar haciendo públicos, en el futuro. Ejemplo RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.
SetSpeakMiddleware	Admita los canales de voz y telefonía de DirectLine para asegurarse de que las etiquetas SSML adecuadas estén establecidas en la propiedad Activity Speak.
CloudSkillHandler	Un controlador de Bot Framework para aptitudes.
SkillHandler
SkillHandlerImpl
SkillHttpClient	BotFrameworkHttpClient especializado en Aptitudes que encapsula la generación de identificadores de conversación.
StatusCodeError	Extiende error para proporcionar mensajes de error especializados.
StreamingHttpClient	Implementación de HttpClient que agrega compatibilidad con las conexiones de streaming.
TokenResolver	Busca OAuthCards en datos adjuntos de actividad y realiza acciones en ellos.
TeamsSSOTokenExchangeMiddleware	Si el nombre de la actividad es signin/tokenExchange, este middleware intentará intercambiar el token y desduplicará la llamada entrante, lo que garantiza que solo se procese una solicitud de intercambio. Si un usuario ha iniciado sesión en varios clientes de Teams, el bot podría recibir un "signin/tokenExchange" de cada cliente. Cada solicitud de intercambio de tokens para un inicio de sesión de usuario específico tendrá un activity.value.id idéntico. Solo el bot debe procesar una de estas solicitudes de intercambio de tokens. Los demás devuelven StatusCodes.PRECONDITION_FAILED. Para un bot distribuido en producción, esto requiere almacenamiento distribuido, lo que garantiza que solo se procese un intercambio de tokens. Este middleware admite el almacenamiento de CosmosDb que se encuentra en botbuilder-azure o MemoryStorage para el desarrollo local.
TeamsActivityHandler	Agrega compatibilidad con eventos e interacciones específicos de Microsoft Teams.
TeamsInfo	Proporciona métodos de utilidad para los eventos e interacciones que se producen en Microsoft Teams.

Interfaces

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer	Interfaz que representa una aplicación rápida o un servidor Restify.
ConnectorClientBuilder	Abstracción para compilar clientes del conector.
Request	Representa un Node.js solicitud HTTP, incluido el conjunto mínimo de propiedades de uso. Compatible con Restify, Express y Node.js http principal.
Response
WebRequest	Representa un objeto de solicitud Express o Restify. Esta interfaz admite el marco de trabajo y no está pensado para llamarse directamente para el código.
WebResponse	Representa un objeto de respuesta Express o Restify. Esta interfaz admite el marco de trabajo y no está pensado para llamarse directamente para el código.

Alias de tipos

RouteHandler

Funciones

validateAndFixActivity(Activity)	Valida una actividad y da formato a los campos de marca de tiempo.
teamsGetChannelId(Activity)	Métodos auxiliares de actividad para Teams.
teamsGetSelectedChannelId(Activity)	Obtiene el identificador de canal seleccionado del equipo de la actividad actual.
teamsGetTeamId(Activity)	Obtiene el identificador de equipo de la actividad actual.
teamsGetTeamInfo(Activity)	Obtiene el objeto TeamsInfo de la actividad actual.
teamsGetTeamMeetingInfo(Activity)	Obtiene el objeto TeamsMeetingInfo de la actividad actual.
teamsGetTenant(Activity)	Obtiene el objeto TenantInfo de la actividad actual.
teamsNotifyUser(Partial<Activity>, boolean, string)	Configura la actividad actual para generar una notificación en Teams.

Detalles de la función

validateAndFixActivity(Activity)

Valida una actividad y da formato a los campos de marca de tiempo.

function validateAndFixActivity(activity: Activity): Activity

Parámetros

activity

Activity

(xref:botbuilder-core. Actividad) que se va a validar.

Devoluciones

Activity

Actividad.

teamsGetChannelId(Activity)

Métodos auxiliares de actividad para Teams.

function teamsGetChannelId(activity: Activity): string | null

Parámetros

activity

Activity

Actividad actual.

Devoluciones

string | null

Identificador de canal del equipo de la actividad actual o null.

teamsGetSelectedChannelId(Activity)

Obtiene el identificador de canal seleccionado del equipo de la actividad actual.

function teamsGetSelectedChannelId(activity: Activity): string

Parámetros

activity

Activity

Actividad actual.

Devoluciones

string

Canal seleccionado del equipo de la actividad actual o cadena vacía.

teamsGetTeamId(Activity)

Obtiene el identificador de equipo de la actividad actual.

function teamsGetTeamId(activity: Activity): string | null

Parámetros

activity

Activity

Actividad actual.

Devoluciones

string | null

Identificador del equipo de la actividad actual o null.

teamsGetTeamInfo(Activity)

Obtiene el objeto TeamsInfo de la actividad actual.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Parámetros

activity

Activity

Actividad actual.

Devoluciones

TeamInfo | null

La información del equipo de la actividad actual o null.

teamsGetTeamMeetingInfo(Activity)

Obtiene el objeto TeamsMeetingInfo de la actividad actual.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Parámetros

activity

Activity

Actividad actual.

Devoluciones

TeamsMeetingInfo | null

La información de reunión del equipo de la actividad actual o null.

teamsGetTenant(Activity)

Obtiene el objeto TenantInfo de la actividad actual.

function teamsGetTenant(activity: Activity): TenantInfo | null

Parámetros

activity

Activity

Actividad actual.

Devoluciones

TenantInfo | null

Información del inquilino de la actividad actual o null.

teamsNotifyUser(Partial<Activity>, boolean, string)

Configura la actividad actual para generar una notificación en Teams.

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

Parámetros

activity

Partial<Activity>

Actividad actual.

alertInMeeting

boolean

Enviado a un chat de reunión, esto hará que el cliente de Teams lo represente en un elemento emergente de notificación, así como en el subproceso de chat.

externalResourceUrl

string

Dirección URL al recurso externo. Debe incluirse en los dominios válidos del manifiesto.