CloudAdapterBase class

  • リファレンス
パッケージ:
botbuilder-core

Bot Framework プロトコルを実装し、パブリックとプライベートの両方の異なるクラウド環境でホストできるアダプター。

Extends
BotAdapter

コンストラクター

CloudAdapterBase(BotFrameworkAuthentication)

新しい CloudAdapterBase インスタンスを作成します。

プロパティ

ConnectorFactoryKey
onTurnError

ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを取得または設定します。 ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを設定します。
UserTokenClientKey

継承されたプロパティ

BotIdentityKey
ConnectorClientKey
OAuthScopeKey

メソッド

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

アダプターのパイプラインにミドルウェアを追加します。

コンストラクターの詳細

CloudAdapterBase(BotFrameworkAuthentication)

新しい CloudAdapterBase インスタンスを作成します。

new CloudAdapterBase(botFrameworkAuthentication: BotFrameworkAuthentication)

パラメーター

botFrameworkAuthentication

BotFrameworkAuthentication

トークンの検証と作成に使用される BotFrameworkAuthentication 。

プロパティの詳細

ConnectorFactoryKey 

ConnectorFactoryKey: symbol

プロパティ値

symbol

onTurnError

ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを取得または設定します。 ミドルウェアまたはアプリケーションで例外をキャッチできるエラー ハンドラーを設定します。

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

プロパティ値

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

非同期操作を表す promise。

注釈

エラー ハンドラーは、次のパラメーターを使用して呼び出されます。

名前 Type 説明
context TurnContext ターンのコンテキスト オブジェクト。
error Error Node.js エラーがスローされました。

UserTokenClientKey 

UserTokenClientKey: symbol

プロパティ値

symbol

継承されたプロパティの詳細

BotIdentityKey 

BotIdentityKey: symbol

プロパティ値

symbol

BotAdapter.BotIdentityKeyから継承されます

ConnectorClientKey 

ConnectorClientKey: symbol

プロパティ値

symbol

BotAdapter.ConnectorClientKeyから継承されます

OAuthScopeKey 

OAuthScopeKey: symbol

プロパティ値

symbol

BotAdapter.OAuthScopeKeyから継承されます

メソッドの詳細

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>

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>

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>

deleteActivity(TurnContext, Partial<ConversationReference>) 

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

パラメーター

context
TurnContext
reference

Partial<ConversationReference>

戻り値

Promise<void>

sendActivities(TurnContext, Partial<Activity>[]) 

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

パラメーター

context
TurnContext
activities

Partial<Activity>[]

戻り値

Promise<ResourceResponse[]>

updateActivity(TurnContext, Partial<Activity>) 

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

パラメーター

context
TurnContext
activity

Partial<Activity>

戻り値

Promise<ResourceResponse | void>

継承済みメソッドの詳細

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から継承