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

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

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

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

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

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

logic

(context: TurnContext) => Promise<void>

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

appId

string

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

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