ChannelServiceHandler クラス

  • java.lang.Object
    • com.microsoft.bot.builder.ChannelServiceHandler

public class ChannelServiceHandler

Bot Framework プロトコルの実装に役立つクラス。

コンストラクターの概要

コンストラクター 説明
ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)

資格情報プロバイダーを使用して、ChannelServiceHandler クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
protected ChannelProvider getChannelProvider()

ChannelProvider を実装するチャネル プロバイダーを取得します。

java.util.concurrent.CompletableFuture<ConversationResourceResponse> handleCreateConversation(String authHeader, ConversationParameters parameters)

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

java.util.concurrent.CompletableFuture<java.lang.Void> handleDeleteActivity(String authHeader, String conversationId, String activityId)

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

java.util.concurrent.CompletableFuture<java.lang.Void> handleDeleteConversationMember(String authHeader, String conversationId, String memberId)

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

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> handleGetActivityMembers(String authHeader, String conversationId, String activityId)

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

java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> handleGetConversationMembers(String authHeader, String conversationId)

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

java.util.concurrent.CompletableFuture<PagedMembersResult> handleGetConversationPagedMembers(String authHeader, String conversationId, Integer pageSize, String continuationToken)

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

java.util.concurrent.CompletableFuture<ConversationsResult> handleGetConversations(String authHeader, String conversationId, String continuationToken)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleReplyToActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleSendConversationHistory(String authHeader, String conversationId, Transcript transcript)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleSendToConversation(String authHeader, String conversationId, Activity activity)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleUpdateActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

java.util.concurrent.CompletableFuture<ResourceResponse> handleUploadAttachment(String authHeader, String conversationId, AttachmentData attachmentUpload)

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

protected java.util.concurrent.CompletableFuture<ConversationResourceResponse> onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

Conversation() API を作成します。

protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

Activity() API削除します。

protected java.util.concurrent.CompletableFuture<java.lang.Void> onDeleteConversationMember(ClaimsIdentity claimsIdentity, String conversationId, String memberId)

ConversationMember() API for Skill削除します。

protected java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

で、アクティビティMembers() API取得します。

protected java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

ConversationMembers() API for Skill取得します。

protected java.util.concurrent.CompletableFuture<PagedMembersResult> onGetConversationPagedMembers(ClaimsIdentity claimsIdentity, String conversationId, Integer pageSize, String continuationToken)

PagedMembers() API for Skill会話取得します。

protected java.util.concurrent.CompletableFuture<ConversationsResult> onGetConversations(ClaimsIdentity claimsIdentity, String conversationId, String continuationToken)

では、スキルConversations() API を取得します。

protected java.util.concurrent.CompletableFuture<ResourceResponse> onReplyToActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

応答ToActivity() API。

protected java.util.concurrent.CompletableFuture<ResourceResponse> onSendConversationHistory(ClaimsIdentity claimsIdentity, String conversationId, Transcript transcript)

スキル会話History() API を送信します。

protected java.util.concurrent.CompletableFuture<ResourceResponse> onSendToConversation(ClaimsIdentity claimsIdentity, String conversationId, Activity activity)

ToConversation() API for Skill を送信します。

protected java.util.concurrent.CompletableFuture<ResourceResponse> onUpdateActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

UpdateActivity() API。

protected java.util.concurrent.CompletableFuture<ResourceResponse> onUploadAttachment(ClaimsIdentity claimsIdentity, String conversationId, AttachmentData attachmentUpload)

Attachment() API をアップロードします。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

コンストラクターの詳細

ChannelServiceHandler

public ChannelServiceHandler(CredentialProvider credentialProvider, AuthenticationConfiguration authConfiguration, ChannelProvider channelProvider)

資格情報プロバイダーを使用して、ChannelServiceHandler クラスの新しいインスタンスを初期化します。

パラメーター:

credentialProvider - 資格情報プロバイダー。
authConfiguration - 認証構成。
channelProvider - チャネル プロバイダー。

メソッドの詳細

getChannelProvider

protected ChannelProvider getChannelProvider()

ChannelProvider を実装するチャネル プロバイダーを取得します。

戻り値:

ChannelProvider 値を getChannelProvider() として指定します。

handleCreateConversation

public CompletableFuture handleCreateConversation(String authHeader, ConversationParameters parameters)

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

パラメーター:

authHeader - 認証ヘッダー。
parameters - 会話の作成に使用するパラメーター。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleDeleteActivity

public CompletableFuture handleDeleteActivity(String authHeader, String conversationId, String activityId)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
activityId - アクティビティ ID。

戻り値:

非同期操作の結果を表す CompletableFuture

handleDeleteConversationMember

public CompletableFuture handleDeleteConversationMember(String authHeader, String conversationId, String memberId)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
memberId - この会話から削除するメンバーの ID。

戻り値:

非同期操作を表す CompletableFuture

handleGetActivityMembers

public CompletableFuture> handleGetActivityMembers(String authHeader, String conversationId, String activityId)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
activityId - アクティビティ ID。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleGetConversationMembers

public CompletableFuture> handleGetConversationMembers(String authHeader, String conversationId)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleGetConversationPagedMembers

public CompletableFuture handleGetConversationPagedMembers(String authHeader, String conversationId, Integer pageSize, String continuationToken)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
pageSize - 推奨されるページ サイズ。
continuationToken - 継続トークン。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleGetConversations

public CompletableFuture handleGetConversations(String authHeader, String conversationId, String continuationToken)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
continuationToken - スキップトークンまたは継続トークン。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleReplyToActivity

public CompletableFuture handleReplyToActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
activityId - 応答のアクティビティ ID。
activity - 送信するアクティビティ。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleSendConversationHistory

public CompletableFuture handleSendConversationHistory(String authHeader, String conversationId, Transcript transcript)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
transcript - アクティビティのトランスクリプト。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleSendToConversation

public CompletableFuture handleSendToConversation(String authHeader, String conversationId, Activity activity)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
activity - 送信するアクティビティ。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleUpdateActivity

public CompletableFuture handleUpdateActivity(String authHeader, String conversationId, String activityId, Activity activity)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
activityId - 更新するアクティビティ ID。
activity - 置換アクティビティ。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

handleUploadAttachment

public CompletableFuture handleUploadAttachment(String authHeader, String conversationId, AttachmentData attachmentUpload)

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

パラメーター:

authHeader - 認証ヘッダー。
conversationId - 会話 ID。
attachmentUpload - 添付ファイル データ。

戻り値:

非同期操作の結果を表す {@link CompletableFuture{TResult}} です。

onCreateConversation

protected CompletableFuture onCreateConversation(ClaimsIdentity claimsIdentity, ConversationParameters parameters)

CreateConversation() API。 新しい会話を作成するには、このメソッドをオーバーライドします。 *ボットが会話を作成するボットである * ボットを使用してこのメソッドに POST します。これが直接メッセージではない場合は IsGroup が true に設定されます (既定の instanceof false) * 会話に含めるメンバーを含む配列。戻り値は、メッセージ ペイロードと REST API URI で使用するのに適した会話 D を含む ResourceResponse です。 ほとんどのチャネルでは、直接メッセージの会話を開始するボットのセマンティクスのみがサポートされます。 その方法の例として、var resource = connector.getconversations() があります。CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); connect.getConversations().OnSendToConversation(resource.getId(), new Activity() ... ) ;終わり。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
parameters - 会話の作成に使用するパラメーター。

戻り値:

会話リソース応答のタスク。

onDeleteActivity

protected CompletableFuture onDeleteActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

OnDeleteActivity() API。 既存のアクティビティを削除するには、このメソッドをオーバーライドします。 一部のチャネルでは、既存のアクティビティを削除できます。成功した場合、このメソッドは指定されたアクティビティを削除します。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
activityId - 削除する activityId。

戻り値:

リソース応答のタスク。

onDeleteConversationMember

protected CompletableFuture onDeleteConversationMember(ClaimsIdentity claimsIdentity, String conversationId, String memberId)

DeleteConversationMember() API for Skill。 会話からメンバーを削除するには、このメソッドをオーバーライドします。 この REST API は、ConversationId と memberId (String 型) を受け取り、そのメンバーを会話から削除します。 そのメンバーが会話の最後のメンバーであった場合、会話も削除されます。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
memberId - この会話から削除するメンバーの D。

戻り値:

タスク。

onGetActivityMembers

protected CompletableFuture> onGetActivityMembers(ClaimsIdentity claimsIdentity, String conversationId, String activityId)

OnGetActivityMembers() API。 アクティビティのメンバーを列挙するには、このメソッドをオーバーライドします。 この REST API は ConversationId と ActivityId を受け取り、会話内の特定のアクティビティのメンバーを表す ChannelAccount オブジェクトの配列を返します。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
activityId - アクティビティ D。

戻り値:

結果を含むタスク。

onGetConversationMembers

protected CompletableFuture> onGetConversationMembers(ClaimsIdentity claimsIdentity, String conversationId)

スキル用の GetConversationMembers() API。 会話のメンバーを列挙するには、このメソッドをオーバーライドします。 この REST API は ConversationId を受け取り、会話のメンバーを表す ChannelAccount オブジェクトの配列を返します。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。

戻り値:

応答のタスク。

onGetConversationPagedMembers

protected CompletableFuture onGetConversationPagedMembers(ClaimsIdentity claimsIdentity, String conversationId, Integer pageSize, String continuationToken)

GetConversationPagedMembers() API for Skill。 会話のメンバーを一度に 1 ページずつ列挙するには、このメソッドをオーバーライドします。 この REST API は ConversationId を受け取ります。 必要に応じて、pageSize または continuationToken を指定できます。 これは、会話のメンバーを表す ChannelAccounts の配列と、より多くの値を取得するために使用できる継続トークンを含む PagedMembersResult を返します。 呼び出しごとに ChannelAccounts レコードの 1 ページが返されます。 ページ内のレコードの数は、チャネルと呼び出しによって異なる場合があります。 pageSize パラメーターは、候補として使用できます。 追加の結果がない場合、応答には継続トークンは含まれません。 会話にメンバーが存在しない場合、メンバーは空であるか、応答に存在しません。 前の要求からの継続トークンを持つ要求に対する応答では、前の要求からメンバーを返す可能性はほとんどありません。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
pageSize - 推奨されるページ サイズ。
continuationToken - 継続トークン。

戻り値:

応答のタスク。

onGetConversations

protected CompletableFuture onGetConversations(ClaimsIdentity claimsIdentity, String conversationId, String continuationToken)

スキル用の OnGetConversations() API。 このメソッドをオーバーライドして、このボットが参加した会話を一覧表示します。 スキップ トークンを持つこのメソッドからの GET 戻り値は ConversationsResult であり、ConversationMembers の配列とスキップ トークンが含まれています。 スキップ トークンが空でない場合は、さらに値が返されます。 返されたトークンを使用してこのメソッドをもう一度呼び出して、より多くの値を取得します。 各 ConversationMembers オブジェクトには、会話の D と、会話のメンバーを記述する ChannelAccounts の配列が含まれています。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - conversationId。
continuationToken - スキップまたは継続トークン。

戻り値:

ConversationsResult のタスク。

onReplyToActivity

protected CompletableFuture onReplyToActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

OnReplyToActivity() API。 このメソッドをオーバーライドすると、アクティビティに応答できます。 これは SendToConversation() とは少し異なります。 * SendToConversation(conversationId) - チャネルのタイムスタンプまたはセマンティクスに従って、アクティビティを会話の最後に追加します。 * ReplyToActivity(conversationId,ActivityId) - チャネルでサポートされている場合は、アクティビティを別のアクティビティへの応答として追加します。 チャネルが入れ子になった応答をサポートしていない場合、ReplyToActivity は SendToConversation にフォールバックします。 会話内の特定のアクティビティに返信する場合は、ReplyToActivity を使用します。 SendToConversation は、他のすべてのケースで使用します。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
activityId - activityId the reply is to (OPTONAL)。
activity - 送信するアクティビティ。

戻り値:

リソース応答のタスク。

onSendConversationHistory

protected CompletableFuture onSendConversationHistory(ClaimsIdentity claimsIdentity, String conversationId, Transcript transcript)

SendConversationHistory() API for Skill。 このメソッドをこのメソッドにオーバーライドすると、履歴アクティビティを会話にアップロードできます。 送信者は、履歴アクティビティに一意の ID と適切なタイムスタンプがあることを確認する必要があります。 ID は、重複するアクティビティを処理するためにクライアントによって使用され、タイムスタンプはクライアントによって適切な順序でアクティビティをレンダリングするために使用されます。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
transcript - アクティビティのトランスクリプト。

戻り値:

リソース応答のタスク。

onSendToConversation

protected CompletableFuture onSendToConversation(ClaimsIdentity claimsIdentity, String conversationId, Activity activity)

SendToConversation() API for Skill。 このメソッドを使用すると、会話の最後にアクティビティを送信できます。 これは ReplyToActivity() とは少し異なります。 * SendToConversation(conversationId) - チャネルのタイムスタンプまたはセマンティクスに従って、アクティビティを会話の最後に追加します。 * ReplyToActivity(conversationId,ActivityId) - チャネルでサポートされている場合は、アクティビティを別のアクティビティへの応答として追加します。 チャネルが入れ子になった応答をサポートしていない場合、ReplyToActivity は SendToConversation にフォールバックします。 会話内の特定のアクティビティに返信する場合は、ReplyToActivity を使用します。 SendToConversation は、他のすべてのケースで使用します。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - conversationId。
activity - 送信するアクティビティ。

戻り値:

リソース応答のタスク。

onUpdateActivity

protected CompletableFuture onUpdateActivity(ClaimsIdentity claimsIdentity, String conversationId, String activityId, Activity activity)

OnUpdateActivity() API。 以前に送信された既存のアクティビティを編集するには、このメソッドをオーバーライドします。 一部のチャネルでは、ボットの会話の新しい状態を反映するように既存のアクティビティを編集できます。 たとえば、他のユーザーが [承認] ボタンをクリックした後にボタンを削除できます。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
activityId - 更新する activityId。
activity - 置き換えアクティビティ。

戻り値:

リソース応答のタスク。

onUploadAttachment

protected CompletableFuture onUploadAttachment(ClaimsIdentity claimsIdentity, String conversationId, AttachmentData attachmentUpload)

UploadAttachment() API。 企業を扱うときに準拠ストアにデータを格納するには、このメソッドをオーバーライドします。 応答は、AttachmentId を含む ResourceResponse であり、添付ファイル API での使用に適しています。

パラメーター:

claimsIdentity - ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
conversationId - 会話 D。
attachmentUpload - 添付ファイル データ。

戻り値:

結果を含むタスク。

適用対象