SkillHandler class

パッケージ:

botbuilder

警告

この API は非推奨になりました。

Use CloudSkillHandler instead. A Bot Framework Handler for skills.

Extends

ChannelServiceHandler

コンストラクター

SkillHandler(BotAdapter, ActivityHandlerBase, SkillConversationIdFactoryBase, ICredentialProvider, AuthenticationConfiguration, string)

SkillHandler クラスの新しいインスタンスを初期化します。

プロパティ

SkillConversationReferenceKey

スキルから親に送信された CovnersationReference にアクセスするために使用されます。

継承されたメソッド

handleCreateConversation(string, ConversationParameters)	新しい会話を作成します。
handleDeleteActivity(string, string, string)	既存の アクティビティを削除します。
handleDeleteConversationMember(string, string, string)	会話からメンバーを削除します。
handleGetActivityMembers(string, string, string)	アクティビティのメンバーを列挙します。
handleGetConversationMember(string, string, string)	1 人の会話メンバーのアカウントを取得します。
handleGetConversationMembers(string, string)	会話のメンバーを列挙します。
handleGetConversationPagedMembers(string, string, number, string)	会話のメンバーを一度に 1 ページずつ列挙します。
handleGetConversations(string, string, string)	ボットが参加した会話を一覧表示します。
handleReplyToActivity(string, string, string, Activity)	アクティビティに応答を送信します。
handleSendConversationHistory(string, string, Transcript)	会話の履歴アクティビティをアップロードします。
handleSendToConversation(string, string, Activity)	アクティビティ を会話の最後に送信します。
handleUpdateActivity(string, string, string, Activity)	以前に送信された既存の アクティビティを編集します。
handleUploadAttachment(string, string, AttachmentData)	企業を扱うときに、準拠ストアにデータを格納します。

コンストラクターの詳細

SkillHandler(BotAdapter, ActivityHandlerBase, SkillConversationIdFactoryBase, ICredentialProvider, AuthenticationConfiguration, string)

SkillHandler クラスの新しいインスタンスを初期化します。

new SkillHandler(adapter: BotAdapter, bot: ActivityHandlerBase, conversationIdFactory: SkillConversationIdFactoryBase, credentialProvider: ICredentialProvider, authConfig: AuthenticationConfiguration, channelService?: string)

パラメーター

adapter

BotAdapter

要求を処理する BotAdapter のインスタンス。

bot

ActivityHandlerBase

ActivityHandlerBase インスタンス。

conversationIdFactory

SkillConversationIdFactoryBase

会話 ID をアンパックし、呼び出し元のボットにマップするための SkillConversationIdFactoryBase。

credentialProvider

ICredentialProvider

資格情報プロバイダー。

authConfig

AuthenticationConfiguration

認証構成。

channelService

string

ボットがパブリック Azure または Azure Government (https://aka.ms/AzureGovDocs) で動作しているかどうかを示す文字列。

プロパティの詳細

SkillConversationReferenceKey

スキルから親に送信された CovnersationReference にアクセスするために使用されます。

SkillConversationReferenceKey: symbol

プロパティ値

symbol

注釈

この値は、botbuilder-core からエクスポートされた SkillConversationReferenceKey と同じです。

継承済みメソッドの詳細

handleCreateConversation(string, ConversationParameters)

新しい会話を作成します。

function handleCreateConversation(authHeader: string, parameters: ConversationParameters): Promise<ConversationResourceResponse>

パラメーター

authHeader

string

認証ヘッダー。

parameters

ConversationParameters

(xref:botbuilder-core。ConversationParameters) を使用して会話を作成します。

戻り値

Promise<ConversationResourceResponse>

操作の Promise 表現。

channelServiceHandlerBase.handleCreateConversation から継承

handleDeleteActivity(string, string, string)

既存の アクティビティを削除します。

function handleDeleteActivity(authHeader: string, conversationId: string, activityId: string): Promise<void>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

activityId

string

削除するアクティビティ ID。

戻り値

Promise<void>

channelServiceHandlerBase.handleDeleteActivityから継承された

handleDeleteConversationMember(string, string, string)

会話からメンバーを削除します。

function handleDeleteConversationMember(authHeader: string, conversationId: string, memberId: string): Promise<void>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

memberId

string

この会話から削除するメンバーの ID。

戻り値

Promise<void>

channelServiceHandlerBase.handleDeleteConversationMemberから継承された

handleGetActivityMembers(string, string, string)

アクティビティのメンバーを列挙します。

function handleGetActivityMembers(authHeader: string, conversationId: string, activityId: string): Promise<ChannelAccount[]>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

activityId

string

アクティビティ ID。

戻り値

Promise<ChannelAccount[]>

ChannelAccount リスト 列挙されます。

channelServiceHandlerBase.handleGetActivityMembersから継承された

handleGetConversationMember(string, string, string)

1 人の会話メンバーのアカウントを取得します。

function handleGetConversationMember(authHeader: string, userId: string, conversationId: string): Promise<ChannelAccount>

パラメーター

authHeader

string

認証ヘッダー。

userId

string

ユーザー ID。

conversationId

string

会話 ID。

戻り値

Promise<ChannelAccount>

指定されたユーザー ID の ChannelAccount。

channelServiceHandlerBase.handleGetConversationMemberから継承された

handleGetConversationMembers(string, string)

会話のメンバーを列挙します。

function handleGetConversationMembers(authHeader: string, conversationId: string): Promise<ChannelAccount[]>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

戻り値

Promise<ChannelAccount[]>

ChannelAccount リスト 列挙されます。

channelServiceHandlerBase.handleGetConversationMembersから継承された

handleGetConversationPagedMembers(string, string, number, string)

会話のメンバーを一度に 1 ページずつ列挙します。

function handleGetConversationPagedMembers(authHeader: string, conversationId: string, pageSize?: number, continuationToken?: string): Promise<PagedMembersResult>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

pageSize

number

推奨されるページ サイズ。

continuationToken

string

継続トークン。

戻り値

Promise<PagedMembersResult>

操作の Promise を表す 。

channelServiceHandlerBase.handleGetConversationPagedMembers から継承された

handleGetConversations(string, string, string)

ボットが参加した会話を一覧表示します。

function handleGetConversations(authHeader: string, conversationId: string, continuationToken?: string): Promise<ConversationsResult>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

continuationToken

string

スキップトークンまたは継続トークン。

戻り値

Promise<ConversationsResult>

操作の Promise 表現。

channelServiceHandlerBase.handleGetConversations から継承

handleReplyToActivity(string, string, string, Activity)

アクティビティに応答を送信します。

function handleReplyToActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

activityId

string

応答のアクティビティ ID。

activity

Activity

送信する アクティビティ。

戻り値

Promise<ResourceResponse>

操作の Promise を表す 。

channelServiceHandlerBase.handleReplyToActivityから継承された

handleSendConversationHistory(string, string, Transcript)

会話の履歴アクティビティをアップロードします。

function handleSendConversationHistory(authHeader: string, conversationId: string, transcript: Transcript): Promise<ResourceResponse>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

transcript

Transcript

(xref:botframework-schema。アクティビティのトランスクリプト)。

戻り値

Promise<ResourceResponse>

操作の Promise を表す 。

channelServiceHandlerBase.handleSendConversationHistoryから継承された

handleSendToConversation(string, string, Activity)

アクティビティ を会話の最後に送信します。

function handleSendToConversation(authHeader: string, conversationId: string, activity: Activity): Promise<ResourceResponse>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

activity

Activity

送信する アクティビティ。

戻り値

Promise<ResourceResponse>

操作の Promise を表す 。

channelServiceHandlerBase.handleSendToConversation から継承

handleUpdateActivity(string, string, string, Activity)

以前に送信された既存の アクティビティを編集します。

function handleUpdateActivity(authHeader: string, conversationId: string, activityId: string, activity: Activity): Promise<ResourceResponse>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

activityId

string

更新するアクティビティ ID。

activity

Activity

置換 アクティビティ。

戻り値

Promise<ResourceResponse>

操作の Promise を表す 。

channelServiceHandlerBase.handleUpdateActivity から継承

handleUploadAttachment(string, string, AttachmentData)

企業を扱うときに、準拠ストアにデータを格納します。

function handleUploadAttachment(authHeader: string, conversationId: string, attachmentUpload: AttachmentData): Promise<ResourceResponse>

パラメーター

authHeader

string

認証ヘッダー。

conversationId

string

会話 ID。

attachmentUpload

AttachmentData

(xref:botframework-schema。AttachmentData)。

戻り値

Promise<ResourceResponse>

操作の Promise を表す 。

channelServiceHandlerBase.handleUploadAttachmentから継承された