botbuilder package

Классы

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase	ChannelServiceHandlerBase реализует API для перенаправления действий навыку и реализует маршрутизацию вызовов ChannelAPI от навыка до бота или адаптера.
ChannelServiceRoutes	Направляет вызовы API с помощью методов ChannelServiceHandler.
CloudAdapter	Адаптер, который реализует протокол Bot Framework и может размещаться в разных облачных средах, как общедоступных, так и частных.
CloudChannelServiceHandler	Класс, помогающий реализовать протокол Bot Framework с помощью BotFrameworkAuthentication.
EventFactory	Содержит служебные методы для создания событий различных типов.
FileTranscriptStore	В хранилище расшифровок файлов хранятся расшифровки в файловой системе с каждым действием в виде файла.
HandoffEventNames	Определяет значения для имен событий передачи.
InspectionMiddleware	InspectionMiddleware для проверки эмулятора действий среды выполнения и BotState.
InspectionState	InspectionState для использования Программой InspectionMiddleware для проверки действий среды выполнения эмулятора и BotState.
RouteConstants	Константы, представляющие путь API, который сразу следует за basePath. В настоящее время они являются внутренними, но мы будем повторно оценивать, чтобы сделать их общедоступными, в будущем. Пример RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.
SetSpeakMiddleware	Поддержка каналов распознавания речи и телефонии DirectLine, чтобы убедиться, что соответствующие теги SSML заданы в свойстве Activity Speak.
CloudSkillHandler	Обработчик Bot Framework для навыков.
SkillHandler
SkillHandlerImpl
SkillHttpClient	BotFrameworkHttpClient, специализированный для навыков, который инкапсулирует создание идентификатора беседы.
StatusCodeError	Расширяет возможности ошибки для предоставления специализированных сообщений об ошибках.
StreamingHttpClient	Реализация HttpClient , которая добавляет совместимость с потоковыми подключениями.
TokenResolver	Поиск OAuthCards во вложениях действий и выполнение действий с ними
TeamsSSOTokenExchangeMiddleware	Если действие называется signin/tokenExchange, это ПО промежуточного слоя попытается обменять маркер и дедупликировать входящий вызов, гарантируя обработку только одного запроса обмена. Если пользователь вошел в несколько клиентов Teams, бот может получить "signin/tokenExchange" от каждого клиента. Каждый запрос на обмен маркерами для определенного имени входа пользователя будет иметь идентичную activity.value.id. Бот должен обрабатывать только один из этих запросов на обмен маркерами. Остальные возвращают StatusCodes.PRECONDITION_FAILED. Для распределенного бота в рабочей среде требуется распределенное хранилище, обеспечивающее обработку только одного обмена маркерами. Это ПО промежуточного слоя поддерживает хранилище CosmosDb в botbuilder-azure или MemoryStorage для локальной разработки.
TeamsActivityHandler	Добавлена поддержка конкретных событий и взаимодействий в Microsoft Teams.
TeamsInfo	Предоставляет служебные методы для событий и взаимодействий, происходящих в Microsoft Teams.

Интерфейсы

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer	Интерфейс, представляющий экспресс-приложение или сервер Restify.
ConnectorClientBuilder	Абстракция для создания клиентов соединителей.
Request	Представляет http-запрос Node.js, включая минимальный набор свойств использования. Совместимость с Restify, Express и Node.js core HTTP.
Response
WebRequest	Представляет объект запроса Express или Restify. Этот интерфейс поддерживает платформу и не предназначен для вызова непосредственно для кода.
WebResponse	Представляет объект ответа Express или Restify. Этот интерфейс поддерживает платформу и не предназначен для вызова непосредственно для кода.

Псевдонимы типа

RouteHandler

Функции

validateAndFixActivity(Activity)	Проверяет действие и форматирует поля метки времени.
teamsGetChannelId(Activity)	Вспомогательные методы действий для Teams.
teamsGetSelectedChannelId(Activity)	Возвращает идентификатор канала, выбранного командой из текущего действия.
teamsGetTeamId(Activity)	Возвращает идентификатор команды из текущего действия.
teamsGetTeamInfo(Activity)	Возвращает объект TeamsInfo из текущего действия.
teamsGetTeamMeetingInfo(Activity)	Возвращает объект TeamsMeetingInfo из текущего действия.
teamsGetTenant(Activity)	Возвращает объект TenantInfo из текущего действия.
teamsNotifyUser(Partial<Activity>, boolean, string)	Настраивает текущее действие для создания уведомления в Teams.

Сведения о функции

validateAndFixActivity(Activity)

Проверяет действие и форматирует поля метки времени.

function validateAndFixActivity(activity: Activity): Activity

Параметры

activity

Activity

(xref:botbuilder-core. Действие) для проверки.

Возвращаемое значение

Activity

Действие.

teamsGetChannelId(Activity)

Вспомогательные методы действий для Teams.

function teamsGetChannelId(activity: Activity): string | null

Параметры

activity

Activity

Текущее действие.

Возвращаемое значение

string | null

Идентификатор канала команды текущего действия или значение NULL.

teamsGetSelectedChannelId(Activity)

Возвращает идентификатор канала, выбранного командой из текущего действия.

function teamsGetSelectedChannelId(activity: Activity): string

Параметры

activity

Activity

Текущее действие.

Возвращаемое значение

string

Выбранный канал команды текущего действия или пустая строка.

teamsGetTeamId(Activity)

Возвращает идентификатор команды из текущего действия.

function teamsGetTeamId(activity: Activity): string | null

Параметры

activity

Activity

Текущее действие.

Возвращаемое значение

string | null

Идентификатор команды текущего действия или значение NULL.

teamsGetTeamInfo(Activity)

Возвращает объект TeamsInfo из текущего действия.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Параметры

activity

Activity

Текущее действие.

Возвращаемое значение

TeamInfo | null

Сведения о команде текущего действия или значение NULL.

teamsGetTeamMeetingInfo(Activity)

Возвращает объект TeamsMeetingInfo из текущего действия.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Параметры

activity

Activity

Текущее действие.

Возвращаемое значение

TeamsMeetingInfo | null

Сведения о собрании команды текущего действия или значение NULL.

teamsGetTenant(Activity)

Возвращает объект TenantInfo из текущего действия.

function teamsGetTenant(activity: Activity): TenantInfo | null

Параметры

activity

Activity

Текущее действие.

Возвращаемое значение

TenantInfo | null

Сведения о клиенте текущего действия или значение NULL.

teamsNotifyUser(Partial<Activity>, boolean, string)

Настраивает текущее действие для создания уведомления в Teams.

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

Параметры

activity

Partial<Activity>

Текущее действие.

alertInMeeting

boolean

Отправка в чат собрания приведет к тому, что клиент Teams будет отображать его во всплывающем окне уведомления, а также в потоке чата.

externalResourceUrl

string

URL-адрес внешнего ресурса. Должен быть включен в допустимые домены манифеста.