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 для использования с помощью Средства ПроверкиMiddleware для проверки эмулятора действий среды выполнения и 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, это ПО промежуточного слоя попытается обменять маркер и дедупликировать входящие вызовы, гарантируя обработку только одного запроса exchange. Если пользователь вошел в несколько клиентов 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	Представляет Node.js HTTP-запрос, включая минимальный набор свойств использования. Совместим с 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-адрес внешнего ресурса. Необходимо включить в допустимые домены манифеста.