Поделиться через

CloudAdapter class

  • Ссылка
Пакет:
botbuilder

Адаптер, который реализует протокол Bot Framework и может размещаться в разных облачных средах, как общедоступных, так и частных.

Extends

CloudAdapterBase

Конструкторы

CloudAdapter(BotFrameworkAuthentication)

Инициализирует новый экземпляр класса CloudAdapter .

Унаследованные свойства

BotIdentityKey
ConnectorClientKey
ConnectorFactoryKey
OAuthScopeKey
onTurnError
UserTokenClientKey

Методы

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Используется для подключения адаптера к именованной трубе.
process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Обработка подключения веб-сокета путем применения функции логики к каждому запросу потоковой передачи.
process(Request, Response, (context: TurnContext) => Promise<void>)

Обработайте веб-запрос, применив функцию логики.

Наследуемые методы

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>)
use((context: TurnContext, next: () => Promise<void>) => Promise<void> | Middleware[])

Добавляет ПО промежуточного слоя в конвейер адаптера.

Сведения о конструкторе

CloudAdapter(BotFrameworkAuthentication)

Инициализирует новый экземпляр класса CloudAdapter .

new CloudAdapter(botFrameworkAuthentication?: BotFrameworkAuthentication)

Параметры

botFrameworkAuthentication

BotFrameworkAuthentication

Необязательный экземпляр BotFrameworkAuthentication

Сведения об унаследованном свойстве

BotIdentityKey 

BotIdentityKey: symbol

Значение свойства

symbol

Наследуется от BotAdapter.BotIdentityKey

ConnectorClientKey 

ConnectorClientKey: symbol

Значение свойства

symbol

Наследуется от BotAdapter.ConnectorClientKey

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

Значение свойства

symbol

Наследуется от CloudAdapterBase.ConnectorFactoryKey

OAuthScopeKey 

OAuthScopeKey: symbol

Значение свойства

symbol

Наследуется от BotAdapter.OAuthScopeKey

onTurnError 

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

Значение свойства

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

Наследуется от BotAdapter.onTurnError

UserTokenClientKey 

UserTokenClientKey: symbol

Значение свойства

symbol

Наследуется от CloudAdapterBase.UserTokenClientKey

Сведения о методе

connectNamedPipe(string, (context: TurnContext) => Promise<void>, string, string, string, number)

Используется для подключения адаптера к именованной трубе.

function connectNamedPipe(pipeName: string, logic: (context: TurnContext) => Promise<void>, appId: string, audience: string, callerId?: string, retryCount?: number): Promise<void>

Параметры

pipeName

string

Имя канала для подключения (примечание. Возвращает два сервера именованных каналов, добавляя к этому имени ".incoming" и ".исходящие"

logic

(context: TurnContext) => Promise<void>

Функция логики, вызываемая для результирующего бота, превращается.

appId

string

Идентификатор приложения бота

audience

string

Аудитория, используемая для исходящего взаимодействия. значение будет зависеть от облачной среды.

callerId

string

Необязательный идентификатор вызывающего абонента

retryCount

number

Необязательный параметр— количество повторных попыток подключения, завершилось сбоем (по умолчанию — 7).

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

Promise<void>

process(Request, INodeSocket, INodeBuffer, (context: TurnContext) => Promise<void>)

Обработка подключения веб-сокета путем применения функции логики к каждому запросу потоковой передачи.

function process(req: Request, socket: INodeSocket, head: INodeBuffer, logic: (context: TurnContext) => Promise<void>): Promise<void>

Параметры

req
Request

Входящий HTTP-запрос

socket

INodeSocket

Соответствующий INodeSocket

head

INodeBuffer

Соответствующий INodeBuffer

logic

(context: TurnContext) => Promise<void>

Применяемая функция логики

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

Promise<void>

обещание, представляющее асинхронную операцию.

process(Request, Response, (context: TurnContext) => Promise<void>)

Обработайте веб-запрос, применив функцию логики.

function process(req: Request, res: Response, logic: (context: TurnContext) => Promise<void>): Promise<void>

Параметры

req
Request

Соответствующий HTTP-ответ

res
Response
logic

(context: TurnContext) => Promise<void>

Применяемая функция логики

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

Promise<void>

обещание, представляющее асинхронную операцию.

Сведения о наследуемом методе

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

Предупреждение

Теперь этот API является нерекомендуемым.

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

Параметры

_reference

Partial<ConversationReference>

_logic

(context: TurnContext) => Promise<void>

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

Promise<void>

Наследуется от CloudAdapterBase.continueConversation

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>

Параметры

botAppIdOrClaimsIdentity

string | ClaimsIdentity

reference

Partial<ConversationReference>

logicOrAudience

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

maybeLogic

(context: TurnContext) => Promise<void>

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

Promise<void>

Наследуется от CloudAdapterBase.continueConversationAsync

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>

Параметры

botAppId

string

channelId

string

serviceUrl

string

audience

string

conversationParameters

ConversationParameters

logic

(context: TurnContext) => Promise<void>

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

Promise<void>

Наследуется от CloudAdapterBase.createConversationAsync

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

Параметры

context

TurnContext

reference

Partial<ConversationReference>

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

Promise<void>

Наследуется от CloudAdapterBase.deleteActivity

sendActivities(TurnContext, Partial<Activity>[]) 

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

Параметры

context

TurnContext

activities

Partial<Activity>[]

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

Promise<ResourceResponse[]>

Наследуется от CloudAdapterBase.sendActivities

updateActivity(TurnContext, Partial<Activity>) 

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

Параметры

context

TurnContext

activity

Partial<Activity>

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

Promise<ResourceResponse | void>

Наследуется от CloudAdapterBase.updateActivity

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

Добавляет ПО промежуточного слоя в конвейер адаптера.

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

Параметры

middlewares

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

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

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

this

Обновленный объект адаптера.

Комментарии

ПО промежуточного слоя добавляется в адаптер во время инициализации. Каждый шаг адаптер вызывает свое ПО промежуточного слоя в том порядке, в котором вы его добавили.

Наследуется от BotAdapter.use