Conversations class

会話を作成します。

new Conversations(client: ConnectorClientContext)

パラメーター

新しい会話を作成します。 を使用してこのメソッドに POST します。

• 会話を作成するボットであるボット
• IsGroup が直接メッセージでない場合は true に設定されます (既定値は false)
• 会話に含めるメンバーを含む配列

戻り値は ResourceResponse で、メッセージ ペイロードと REST API URI での使用に適した会話 ID が含まれています。

ほとんどのチャネルでは、直接メッセージ会話を開始するボットのセマンティクスのみがサポートされます。 その方法の例を次に示します。

const resource = await connector.conversations.createConversation({
    bot,
    members: [{ id: 'user1' }]
});
await connector.conversations.sendToConversation(resource.Id, ... );

function createConversation(parameters: ConversationParameters, options?: RequestOptionsBase): Promise<Models.ConversationsCreateConversationResponse>

パラメーター

戻り値

Promise<Models.ConversationsCreateConversationResponse>

function createConversation(parameters: ConversationParameters, options: RequestOptionsBase, callback: ServiceCallback<ConversationResourceResponse>)

パラメーター

function createConversation(parameters: ConversationParameters, callback: ServiceCallback<ConversationResourceResponse>)

パラメーター

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

function deleteActivity(conversationId: string, activityId: string, options?: RequestOptionsBase): Promise<RestResponse>

パラメーター

戻り値

Promise<msRest.RestResponse>

function deleteActivity(conversationId: string, activityId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

パラメーター

function deleteActivity(conversationId: string, activityId: string, callback: ServiceCallback<void>)

パラメーター

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

function deleteConversationMember(conversationId: string, memberId: string, options?: RequestOptionsBase): Promise<RestResponse>

パラメーター

戻り値

Promise<msRest.RestResponse>

function deleteConversationMember(conversationId: string, memberId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

パラメーター

function deleteConversationMember(conversationId: string, memberId: string, callback: ServiceCallback<void>)

パラメーター

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

function getActivityMembers(conversationId: string, activityId: string, options?: RequestOptionsBase): Promise<Models.ConversationsGetActivityMembersResponse>

パラメーター

戻り値

Promise<Models.ConversationsGetActivityMembersResponse>

function getActivityMembers(conversationId: string, activityId: string, options: RequestOptionsBase, callback: ServiceCallback<ChannelAccount[]>)

パラメーター

function getActivityMembers(conversationId: string, activityId: string, callback: ServiceCallback<ChannelAccount[]>)

パラメーター

function getConversationMember(conversationId: string, memberId: string, options?: RequestOptionsBase | ServiceCallback<ChannelAccount[]>, callback?: ServiceCallback<ChannelAccount[]>): Promise<Models.ConversationsGetConversationMemberResponse>

パラメーター

戻り値

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

function getConversationMembers(conversationId: string, options?: RequestOptionsBase): Promise<Models.ConversationsGetConversationMembersResponse>

パラメーター

戻り値

Promise<Models.ConversationsGetConversationMembersResponse>

function getConversationMembers(conversationId: string, options: RequestOptionsBase, callback: ServiceCallback<ChannelAccount[]>)

パラメーター

function getConversationMembers(conversationId: string, callback: ServiceCallback<ChannelAccount[]>)

パラメーター

会話のメンバーを一度に 1 ページずつ列挙します。 この REST API は ConversationId を受け取ります。 必要に応じて、pageSize または continuationToken を指定できます。 PagedMembersResult を返します。これには、会話のメンバーを表す ChannelAccounts の配列と、より多くの値を取得するために使用できる継続トークンが含まれます。

ChannelAccounts レコードの 1 ページが、呼び出しごとに返されます。 ページ内のレコードの数は、チャネルと呼び出しによって異なる場合があります。 pageSize パラメーターは、候補として使用できます。 追加の結果がない場合、応答には継続トークンは含まれません。 会話にメンバーが存在しない場合、メンバーは空であるか、応答に存在しません。

以前の要求からの継続トークンを持つ要求に対する応答で、前の要求のメンバーが返されることはほとんどありません。

function getConversationPagedMembers(conversationId: string, options?: ConversationsGetConversationPagedMembersOptionalParams): Promise<Models.ConversationsGetConversationPagedMembersResponse>

パラメーター

戻り値

Promise<Models.ConversationsGetConversationPagedMembersResponse>

function getConversationPagedMembers(conversationId: string, options: ConversationsGetConversationPagedMembersOptionalParams, callback: ServiceCallback<PagedMembersResult>)

パラメーター

function getConversationPagedMembers(conversationId: string, callback: ServiceCallback<PagedMembersResult>)

パラメーター

このボットが参加した会話を一覧表示します。 スキップ トークンを使用してこのメソッドから取得する

戻り値は ConversationsResult で、ConversationMembers の配列とスキップ トークンが含まれています。 スキップ トークンが空でない場合は、さらに値が返されます。 返されたトークンを使用してこのメソッドをもう一度呼び出して、より多くの値を取得します。

各 ConversationMembers オブジェクトには、会話の ID と、会話のメンバーを記述する ChannelAccounts の配列が含まれます。

function getConversations(options?: ConversationsGetConversationsOptionalParams): Promise<Models.ConversationsGetConversationsResponse>

パラメーター

戻り値

Promise<Models.ConversationsGetConversationsResponse>

function getConversations(options: ConversationsGetConversationsOptionalParams, callback: ServiceCallback<ConversationsResult>)

パラメーター

function getConversations(callback: ServiceCallback<ConversationsResult>)

パラメーター

このメソッドを使用すると、アクティビティに返信できます。 これは、SendToConversation() とは若干異なります。

• SendToConversation(conversationId) - チャネルのタイムスタンプまたはセマンティクスに従って、アクティビティを会話の最後に追加します。
• ReplyToActivity(conversationId,ActivityId) - チャネルでサポートされている場合は、アクティビティを別のアクティビティへの応答として追加します。 チャネルが入れ子になった応答をサポートしていない場合、ReplyToActivity は SendToConversation にフォールバックします。

会話内の特定のアクティビティに返信するときは、ReplyToActivity を使用します。

他のすべてのケースでは、SendToConversation を使用します。

function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsReplyToActivityResponse>

パラメーター

戻り値

Promise<Models.ConversationsReplyToActivityResponse>

function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

パラメーター

function replyToActivity(conversationId: string, activityId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)

パラメーター

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

function sendConversationHistory(conversationId: string, history: Transcript, options?: RequestOptionsBase): Promise<Models.ConversationsSendConversationHistoryResponse>

パラメーター

戻り値

Promise<Models.ConversationsSendConversationHistoryResponse>

function sendConversationHistory(conversationId: string, history: Transcript, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

パラメーター

function sendConversationHistory(conversationId: string, history: Transcript, callback: ServiceCallback<ResourceResponse>)

パラメーター

このメソッドを使用すると、会話の最後にアクティビティを送信できます。 これは ReplyToActivity() とは少し異なります。

• SendToConversation(conversationId) - チャネルのタイムスタンプまたはセマンティクスに従って、アクティビティを会話の最後に追加します。
• ReplyToActivity(conversationId,ActivityId) - チャネルでサポートされている場合は、アクティビティを別のアクティビティへの応答として追加します。 チャネルが入れ子になった応答をサポートしていない場合、ReplyToActivity は SendToConversation にフォールバックします。

会話内の特定のアクティビティに返信するときは、ReplyToActivity を使用します。

他のすべてのケースでは、SendToConversation を使用します。

function sendToConversation(conversationId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsSendToConversationResponse>

パラメーター

戻り値

Promise<Models.ConversationsSendToConversationResponse>

function sendToConversation(conversationId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

パラメーター

function sendToConversation(conversationId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)

パラメーター

既存のアクティビティを編集します。 一部のチャネルでは、既存のアクティビティを編集してボットの会話の新しい状態を反映させることができます。

たとえば、他のユーザーが [承認] ボタンをクリックした後にボタンを削除できます。

function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options?: RequestOptionsBase): Promise<Models.ConversationsUpdateActivityResponse>

パラメーター

戻り値

Promise<Models.ConversationsUpdateActivityResponse>

function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

パラメーター

function updateActivity(conversationId: string, activityId: string, activity: Partial<Activity>, callback: ServiceCallback<ResourceResponse>)

パラメーター

添付ファイルをチャネルの BLOB ストレージに直接アップロードします。 これは、企業を扱うときに準拠ストアにデータを格納できるため便利です。

応答は ResourceResponse であり、attachments API での 使用に適した AttachmentId が含まれています。

function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, options?: RequestOptionsBase): Promise<Models.ConversationsUploadAttachmentResponse>

パラメーター

戻り値

Promise<Models.ConversationsUploadAttachmentResponse>

function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, options: RequestOptionsBase, callback: ServiceCallback<ResourceResponse>)

パラメーター

function uploadAttachment(conversationId: string, attachmentUpload: AttachmentData, callback: ServiceCallback<ResourceResponse>)

パラメーター