Conversations インターフェイス

public abstract CompletableFuture createConversation(ConversationParameters parameters)

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

パラメーター:

戻り値:

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity。 既存のアクティビティを削除します。 一部のチャネルでは、既存のアクティビティを削除できます。成功した場合、このメソッドは指定されたアクティビティを削除します。

パラメーター:

戻り値:

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember。 会話からメンバーを削除します。 この REST API は、ConversationId と memberId (文字列型) を受け取り、そのメンバーを会話から削除します。 そのメンバーが会話の最後のメンバーであった場合、会話も削除されます。

パラメーター:

戻り値:

public abstract CompletableFuture> getActivityMembers(String conversationId, String activityId)

GetActivityMembers。 アクティビティのメンバーを列挙します。 この REST API は ConversationId と ActivityId を受け取り、会話内の特定のアクティビティのメンバーを表す ChannelAccount オブジェクトの配列を返します。

パラメーター:

戻り値:

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

ID で会話の単一メンバーを取得します。

パラメーター:

戻り値:

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers。 会話のメンバーを列挙します。 この REST API は ConversationId を受け取り、会話のメンバーを表す ChannelAccount オブジェクトの配列を返します。

パラメーター:

戻り値:

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

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

パラメーター:

戻り値:

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

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

パラメーター:

戻り値:

public abstract CompletableFuture getConversations()

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

戻り値:

public abstract CompletableFuture getConversations(String continuationToken)

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

パラメーター:

戻り値:

public default CompletableFuture replyToActivity(Activity activity)

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

パラメーター:

戻り値:

public abstract CompletableFuture replyToActivity(String conversationId, String activityId, Activity activity)

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

パラメーター:

戻り値:

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

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

パラメーター:

戻り値:

public default CompletableFuture sendToConversation(Activity activity)

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

パラメーター:

戻り値:

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

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

パラメーター:

戻り値:

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity。 既存のアクティビティを編集します。 一部のチャネルでは、ボットの会話の新しい状態を反映するように既存のアクティビティを編集できます。 たとえば、他のユーザーが [承認] ボタンをクリックした後にボタンを削除できます。

パラメーター:

戻り値:

public abstract CompletableFuture updateActivity(String conversationId, String activityId, Activity activity)

UpdateActivity。 既存のアクティビティを編集します。 一部のチャネルでは、ボットの会話の新しい状態を反映するように既存のアクティビティを編集できます。 たとえば、他のユーザーが [承認] ボタンをクリックした後にボタンを削除できます。

パラメーター:

戻り値:

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment。 チャネルの BLOB ストレージに添付ファイルを直接アップロードします。 これは、企業を扱うときに準拠したストアにデータを格納できるため便利です。 応答は、AttachmentId を含む ResourceResponse であり、添付ファイル API での使用に適しています。

パラメーター:

戻り値: