Share via

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>)

各ストリーミング要求にロジック関数を適用して、Web ソケット接続を処理します。
process(Request, Response, (context: TurnContext) => Promise<void>)

ロジック関数を適用して Web 要求を処理します。

継承されたメソッド

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" と ".outgoing" を追加することで、2 つの名前付きパイプ サーバーが生成されます)

logic

(context: TurnContext) => Promise<void>

結果のボットを呼び出すロジック関数がターンします。

appId

string

ボット アプリケーション ID

audience

string

送信通信に使用する対象ユーザー。 はクラウド環境によって異なります。

callerId

string

省略可能、呼び出し元 ID

retryCount

number

省略可能。失敗した接続を再試行する回数 (既定値は 7)

戻り値

Promise<void>

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

各ストリーミング要求にロジック関数を適用して、Web ソケット接続を処理します。

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>

非同期操作を表す promise。

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

ロジック関数を適用して Web 要求を処理します。

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>

非同期操作を表す promise。

継承済みメソッドの詳細

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