Conversations class

パッケージ:

botframework-connector

会話を表すクラス。

コンストラクター

Conversations(ConnectorClientContext)

会話を作成します。

メソッド

createConversation(ConversationParameters, RequestOptionsBase)	新しい会話を作成します。 を使用してこのメソッドに 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, ... );
createConversation(ConversationParameters, RequestOptionsBase, ServiceCallback<ConversationResourceResponse>)
createConversation(ConversationParameters, ServiceCallback<ConversationResourceResponse>)
deleteActivity(string, string, RequestOptionsBase)	既存のアクティビティを削除します。 一部のチャネルでは、既存のアクティビティを削除できます。成功した場合、このメソッドは指定されたアクティビティを削除します。
deleteActivity(string, string, RequestOptionsBase, ServiceCallback<void>)
deleteActivity(string, string, ServiceCallback<void>)
deleteConversationMember(string, string, RequestOptionsBase)	会話からメンバーを削除します。 この REST API は、ConversationId と memberId (文字列型) を受け取り、そのメンバーを会話から削除します。 そのメンバーが会話の最後のメンバーであった場合、会話も削除されます。
deleteConversationMember(string, string, RequestOptionsBase, ServiceCallback<void>)
deleteConversationMember(string, string, ServiceCallback<void>)
getActivityMembers(string, string, RequestOptionsBase)	アクティビティのメンバーを列挙します。 この REST API は ConversationId と ActivityId を受け取り、会話内の特定のアクティビティのメンバーを表す ChannelAccount オブジェクトの配列を返します。
getActivityMembers(string, string, RequestOptionsBase, ServiceCallback<ChannelAccount[]>)
getActivityMembers(string, string, ServiceCallback<ChannelAccount[]>)
getConversationMember(string, string, RequestOptionsBase | ServiceCallback<ChannelAccount[]>, ServiceCallback<ChannelAccount[]>)
getConversationMembers(string, RequestOptionsBase)	会話のメンバーを列挙します。 この REST API は ConversationId を受け取り、会話のメンバーを表す ChannelAccount オブジェクトの配列を返します。
getConversationMembers(string, RequestOptionsBase, ServiceCallback<ChannelAccount[]>)
getConversationMembers(string, ServiceCallback<ChannelAccount[]>)
getConversationPagedMembers(string, ConversationsGetConversationPagedMembersOptionalParams)	会話のメンバーを一度に 1 ページずつ列挙します。 この REST API は ConversationId を受け取ります。 必要に応じて、pageSize または continuationToken を指定できます。 これは、会話のメンバーを表す ChannelAccounts の配列と、より多くの値を取得するために使用できる継続トークンを含む PagedMembersResult を返します。 呼び出しごとに ChannelAccounts レコードの 1 ページが返されます。 ページ内のレコードの数は、チャネルと呼び出しによって異なる場合があります。 pageSize パラメーターは、候補として使用できます。 追加の結果がない場合、応答には継続トークンは含まれません。 会話にメンバーが存在しない場合、メンバーは空であるか、応答に存在しません。 前の要求からの継続トークンを持つ要求に対する応答では、前の要求からメンバーを返す可能性はほとんどありません。
getConversationPagedMembers(string, ConversationsGetConversationPagedMembersOptionalParams, ServiceCallback<PagedMembersResult>)
getConversationPagedMembers(string, ServiceCallback<PagedMembersResult>)
getConversations(ConversationsGetConversationsOptionalParams)	このボットが参加した会話を一覧表示します。 スキップ トークンを使用してこのメソッドから GET を取得する 戻り値は ConversationsResult で、ConversationMembers の配列とスキップ トークンが含まれています。 スキップ トークンが空でない場合は、さらに値が返されます。 返されたトークンを使用してこのメソッドをもう一度呼び出して、より多くの値を取得します。 各 ConversationMembers オブジェクトには、会話の ID と、会話のメンバーを記述する ChannelAccounts の配列が含まれています。
getConversations(ConversationsGetConversationsOptionalParams, ServiceCallback<ConversationsResult>)
getConversations(ServiceCallback<ConversationsResult>)
replyToActivity(string, string, Partial<Activity>, RequestOptionsBase)	このメソッドを使用すると、アクティビティに返信できます。 これは SendToConversation() とは少し異なります。 SendToConversation(conversationId) - チャネルのタイムスタンプまたはセマンティクスに従って、アクティビティを会話の最後に追加します。 ReplyToActivity(conversationId,ActivityId) - チャネルでサポートされている場合は、アクティビティを別のアクティビティへの応答として追加します。 チャネルが入れ子になった応答をサポートしていない場合、ReplyToActivity は SendToConversation にフォールバックします。 会話内の特定のアクティビティに返信する場合は、ReplyToActivity を使用します。 SendToConversation は、他のすべてのケースで使用します。
replyToActivity(string, string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)
replyToActivity(string, string, Partial<Activity>, ServiceCallback<ResourceResponse>)
sendConversationHistory(string, Transcript, RequestOptionsBase)	このメソッドを使用すると、履歴アクティビティを会話にアップロードできます。 送信者は、履歴アクティビティに一意の ID と適切なタイムスタンプがあることを確認する必要があります。 ID は、重複するアクティビティを処理するためにクライアントによって使用され、タイムスタンプはクライアントによって適切な順序でアクティビティをレンダリングするために使用されます。
sendConversationHistory(string, Transcript, RequestOptionsBase, ServiceCallback<ResourceResponse>)
sendConversationHistory(string, Transcript, ServiceCallback<ResourceResponse>)
sendToConversation(string, Partial<Activity>, RequestOptionsBase)	このメソッドを使用すると、会話の最後にアクティビティを送信できます。 これは ReplyToActivity() とは少し異なります。 SendToConversation(conversationId) - チャネルのタイムスタンプまたはセマンティクスに従って、アクティビティを会話の最後に追加します。 ReplyToActivity(conversationId,ActivityId) - チャネルでサポートされている場合は、アクティビティを別のアクティビティへの応答として追加します。 チャネルが入れ子になった応答をサポートしていない場合、ReplyToActivity は SendToConversation にフォールバックします。 会話内の特定のアクティビティに返信する場合は、ReplyToActivity を使用します。 SendToConversation は、他のすべてのケースで使用します。
sendToConversation(string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)
sendToConversation(string, Partial<Activity>, ServiceCallback<ResourceResponse>)
updateActivity(string, string, Partial<Activity>, RequestOptionsBase)	既存のアクティビティを編集します。 一部のチャネルでは、ボットの会話の新しい状態を反映するように既存のアクティビティを編集できます。 たとえば、他のユーザーが [承認] ボタンをクリックした後にボタンを削除できます。
updateActivity(string, string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)
updateActivity(string, string, Partial<Activity>, ServiceCallback<ResourceResponse>)
uploadAttachment(string, AttachmentData, RequestOptionsBase)	チャネルの BLOB ストレージに添付ファイルを直接アップロードします。 これは、企業を扱うときに準拠したストアにデータを格納できるため便利です。 応答は、AttachmentId を含む ResourceResponse であり、添付ファイル API での使用に適しています。
uploadAttachment(string, AttachmentData, RequestOptionsBase, ServiceCallback<ResourceResponse>)
uploadAttachment(string, AttachmentData, ServiceCallback<ResourceResponse>)

コンストラクターの詳細

Conversations(ConnectorClientContext)

会話を作成します。

new Conversations(client: ConnectorClientContext)

パラメーター

client

ConnectorClientContext

サービス クライアントへの参照。

メソッドの詳細

createConversation(ConversationParameters, RequestOptionsBase)

新しい会話を作成します。 を使用してこのメソッドに 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>

パラメーター

parameters

ConversationParameters

会話を作成するパラメーター

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsCreateConversationResponse>

Promise<Models.ConversationsCreateConversationResponse>

createConversation(ConversationParameters, RequestOptionsBase, ServiceCallback<ConversationResourceResponse>)

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

パラメーター

parameters

ConversationParameters

会話を作成するパラメーター

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ConversationResourceResponse>

コールバック

createConversation(ConversationParameters, ServiceCallback<ConversationResourceResponse>)

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

パラメーター

parameters

ConversationParameters

会話を作成するパラメーター

callback

ServiceCallback<ConversationResourceResponse>

コールバック

deleteActivity(string, string, RequestOptionsBase)

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

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

パラメーター

conversationId

string

会話 ID

activityId

string

削除する activityId

options

RequestOptionsBase

戻り値

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteActivity(string, string, RequestOptionsBase, ServiceCallback<void>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

削除する activityId

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

deleteActivity(string, string, ServiceCallback<void>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

削除する activityId

callback

ServiceCallback<void>

コールバック

deleteConversationMember(string, string, RequestOptionsBase)

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

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

パラメーター

conversationId

string

会話 ID

memberId

string

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

options

RequestOptionsBase

戻り値

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteConversationMember(string, string, RequestOptionsBase, ServiceCallback<void>)

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

パラメーター

conversationId

string

会話 ID

memberId

string

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

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<void>

コールバック

deleteConversationMember(string, string, ServiceCallback<void>)

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

パラメーター

conversationId

string

会話 ID

memberId

string

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

callback

ServiceCallback<void>

コールバック

getActivityMembers(string, string, RequestOptionsBase)

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

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

パラメーター

conversationId

string

会話 ID

activityId

string

アクティビティ ID

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsGetActivityMembersResponse>

Promise<Models.ConversationsGetActivityMembersResponse>

getActivityMembers(string, string, RequestOptionsBase, ServiceCallback<ChannelAccount[]>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

アクティビティ ID

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ChannelAccount[]>

コールバック

getActivityMembers(string, string, ServiceCallback<ChannelAccount[]>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

アクティビティ ID

callback

ServiceCallback<ChannelAccount[]>

コールバック

getConversationMember(string, string, RequestOptionsBase | ServiceCallback<ChannelAccount[]>, ServiceCallback<ChannelAccount[]>)

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

パラメーター

conversationId

string

会話 ID

memberId

string

ユーザーの MemberId

options

RequestOptionsBase | ServiceCallback<ChannelAccount[]>

省略可能なパラメーター

callback

ServiceCallback<ChannelAccount[]>

コールバック

戻り値

Promise<Models.ConversationsGetConversationMemberResponse>

getConversationMembers(string, RequestOptionsBase)

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

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

パラメーター

conversationId

string

会話 ID

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsGetConversationMembersResponse>

Promise<Models.ConversationsGetConversationMembersResponse>

getConversationMembers(string, RequestOptionsBase, ServiceCallback<ChannelAccount[]>)

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

パラメーター

conversationId

string

会話 ID

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ChannelAccount[]>

コールバック

getConversationMembers(string, ServiceCallback<ChannelAccount[]>)

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

パラメーター

conversationId

string

会話 ID

callback

ServiceCallback<ChannelAccount[]>

コールバック

getConversationPagedMembers(string, ConversationsGetConversationPagedMembersOptionalParams)

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

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

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

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

パラメーター

conversationId

string

会話 ID

options

ConversationsGetConversationPagedMembersOptionalParams

戻り値

Promise<Models.ConversationsGetConversationPagedMembersResponse>

Promise<Models.ConversationsGetConversationPagedMembersResponse>

getConversationPagedMembers(string, ConversationsGetConversationPagedMembersOptionalParams, ServiceCallback<PagedMembersResult>)

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

パラメーター

conversationId

string

会話 ID

options

ConversationsGetConversationPagedMembersOptionalParams

省略可能なパラメーター

callback

ServiceCallback<PagedMembersResult>

コールバック

getConversationPagedMembers(string, ServiceCallback<PagedMembersResult>)

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

パラメーター

conversationId

string

会話 ID

callback

ServiceCallback<PagedMembersResult>

コールバック

getConversations(ConversationsGetConversationsOptionalParams)

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

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

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

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

パラメーター

options

ConversationsGetConversationsOptionalParams

戻り値

Promise<Models.ConversationsGetConversationsResponse>

Promise<Models.ConversationsGetConversationsResponse>

getConversations(ConversationsGetConversationsOptionalParams, ServiceCallback<ConversationsResult>)

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

パラメーター

options

ConversationsGetConversationsOptionalParams

省略可能なパラメーター

callback

ServiceCallback<ConversationsResult>

コールバック

getConversations(ServiceCallback<ConversationsResult>)

function getConversations(callback: ServiceCallback<ConversationsResult>)

パラメーター

callback

ServiceCallback<ConversationsResult>

コールバック

replyToActivity(string, string, Partial<Activity>, RequestOptionsBase)

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

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

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

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

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

パラメーター

conversationId

string

会話 ID

activityId

string

activityId the reply is to (OPTIONAL)

activity

Partial<Activity>

送信するアクティビティ

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsReplyToActivityResponse>

Promise<Models.ConversationsReplyToActivityResponse>

replyToActivity(string, string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

activityId the reply is to (OPTIONAL)

activity

Partial<Activity>

送信するアクティビティ

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ResourceResponse>

コールバック

replyToActivity(string, string, Partial<Activity>, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

activityId the reply is to (OPTIONAL)

activity

Partial<Activity>

送信するアクティビティ

callback

ServiceCallback<ResourceResponse>

コールバック

sendConversationHistory(string, Transcript, RequestOptionsBase)

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

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

パラメーター

conversationId

string

会話 ID

history

Transcript

歴史的な活動

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsSendConversationHistoryResponse>

Promise<Models.ConversationsSendConversationHistoryResponse>

sendConversationHistory(string, Transcript, RequestOptionsBase, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

history

Transcript

歴史的な活動

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ResourceResponse>

コールバック

sendConversationHistory(string, Transcript, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

history

Transcript

歴史的な活動

callback

ServiceCallback<ResourceResponse>

コールバック

sendToConversation(string, Partial<Activity>, RequestOptionsBase)

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

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

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

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

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

パラメーター

conversationId

string

会話 ID

activity

Partial<Activity>

送信するアクティビティ

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsSendToConversationResponse>

Promise<Models.ConversationsSendToConversationResponse>

sendToConversation(string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

activity

Partial<Activity>

送信するアクティビティ

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ResourceResponse>

コールバック

sendToConversation(string, Partial<Activity>, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

activity

Partial<Activity>

送信するアクティビティ

callback

ServiceCallback<ResourceResponse>

コールバック

updateActivity(string, string, Partial<Activity>, RequestOptionsBase)

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

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

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

パラメーター

conversationId

string

会話 ID

activityId

string

更新する activityId

activity

Partial<Activity>

replacement アクティビティ

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsUpdateActivityResponse>

Promise<Models.ConversationsUpdateActivityResponse>

updateActivity(string, string, Partial<Activity>, RequestOptionsBase, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

更新する activityId

activity

Partial<Activity>

replacement アクティビティ

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ResourceResponse>

コールバック

updateActivity(string, string, Partial<Activity>, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

activityId

string

更新する activityId

activity

Partial<Activity>

replacement アクティビティ

callback

ServiceCallback<ResourceResponse>

コールバック

uploadAttachment(string, AttachmentData, RequestOptionsBase)

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

応答は、AttachmentId を含む ResourceResponse であり、添付ファイル API での使用に適しています。

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

パラメーター

conversationId

string

会話 ID

attachmentUpload

AttachmentData

添付ファイル データ

options

RequestOptionsBase

戻り値

Promise<Models.ConversationsUploadAttachmentResponse>

Promise<Models.ConversationsUploadAttachmentResponse>

uploadAttachment(string, AttachmentData, RequestOptionsBase, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

attachmentUpload

AttachmentData

添付ファイル データ

options

RequestOptionsBase

省略可能なパラメーター

callback

ServiceCallback<ResourceResponse>

コールバック

uploadAttachment(string, AttachmentData, ServiceCallback<ResourceResponse>)

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

パラメーター

conversationId

string

会話 ID

attachmentUpload

AttachmentData

添付ファイル データ

callback

ServiceCallback<ResourceResponse>

コールバック