다음을 통해 공유


Conversations 인터페이스

public interface Conversations

이 클래스의 인스턴스는 대화에 정의된 모든 작업에 대한 액세스를 제공합니다.

메서드 요약

한정자 및 형식 메서드 및 설명
abstract java.util.concurrent.CompletableFuture<ConversationResourceResponse> createConversation(ConversationParameters parameters)

대화를 만듭니다.

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(String conversationId, String activityId)

작업을 삭제합니다.

abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteConversationMember(String conversationId, String memberId)

대화멤버를 삭제합니다.

abstract java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getActivityMembers(String conversationId, String activityId)

활동멤버를 가져옵니다.

abstract java.util.concurrent.CompletableFuture<ChannelAccount> getConversationMember(String userId, String conversationId)

ID로 대화의 단일 멤버를 검색합니다.

abstract java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getConversationMembers(String conversationId)

대화멤버를 가져옵니다.

abstract java.util.concurrent.CompletableFuture<PagedMembersResult> getConversationPagedMembers(String conversationId)

대화의 멤버를 한 번에 한 페이지씩 열거합니다.

abstract java.util.concurrent.CompletableFuture<PagedMembersResult> getConversationPagedMembers(String conversationId, String continuationToken)

대화의 멤버를 한 번에 한 페이지씩 열거합니다.

abstract java.util.concurrent.CompletableFuture<ConversationsResult> getConversations()

대화를 가져옵니다.

abstract java.util.concurrent.CompletableFuture<ConversationsResult> getConversations(String continuationToken)

대화를 가져옵니다.

default java.util.concurrent.CompletableFuture<ResourceResponse> replyToActivity(Activity activity)

회신합니다.

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

회신합니다.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendConversationHistory(String conversationId, Transcript history)

이 메서드를 사용하면 대화에 기록 활동을 업로드할 수 있습니다.

default java.util.concurrent.CompletableFuture<ResourceResponse> sendToConversation(Activity activity)

ToConversation을 보냅니다.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> sendToConversation(String conversationId, Activity activity)

ToConversation을 보냅니다.

default java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(Activity activity)

작업을 업데이트합니다.

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

작업을 업데이트합니다.

abstract java.util.concurrent.CompletableFuture<ResourceResponse> uploadAttachment(String conversationId, AttachmentData attachmentUpload)

첨부 파일을 업로드합니다.

메서드 세부 정보

createConversation

public abstract CompletableFuture createConversation(ConversationParameters parameters)

CreateConversation. 새 대화를 만듭니다. 직접 메시지(기본값은 false)가 아니면 봇이 대화를 만드는 봇이 true로 설정된 상태에서 이 메서드에 POST를 게시하면 대화에 포함하려는 멤버가 연결됩니다. 반환 값은 메시지 페이로드 및 REST API URI에 사용하기에 적합한 대화 ID를 포함하는 ResourceResponse입니다. 대부분의 채널은 직접 메시지 대화를 시작하는 봇의 의미 체계만 지원합니다. 이 작업을 수행하는 방법의 예는 다음과 같습니다. ''' var resource = await connector.conversation.CreateConversation(new ConversationParameters(){ Bot = bot, members = new ChannelAccount[] { new ChannelAccount("user1") } ); await connect. Conversations.SendToConversation(resource. ID, 새 활동() ... ) ; ```

매개 변수:

parameters - 에서 대화를 만들 매개 변수

반환:

ConversationResourceResponse 개체에 대해 관찰할 수 있는 개체입니다.

deleteActivity

public abstract CompletableFuture deleteActivity(String conversationId, String activityId)

DeleteActivity. 기존 활동을 삭제합니다. 일부 채널을 사용하면 기존 활동을 삭제할 수 있으며, 성공하면 이 메서드가 지정된 활동을 제거합니다.

매개 변수:

conversationId - 대화 ID
activityId - 삭제할 activityId

반환:

성공하면 ServiceResponse<T> 개체입니다.

deleteConversationMember

public abstract CompletableFuture deleteConversationMember(String conversationId, String memberId)

DeleteConversationMember. 대화에서 멤버를 삭제합니다. 이 REST API는 ConversationId 및 memberId(문자열 형식)를 사용하고 대화에서 해당 멤버를 제거합니다. 해당 멤버가 대화의 마지막 멤버인 경우 대화도 삭제됩니다.

매개 변수:

conversationId - 대화 ID
memberId - 이 대화에서 삭제할 멤버의 ID

반환:

성공하면 ServiceResponse<T> 개체입니다.

getActivityMembers

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

GetActivityMembers. 활동의 멤버를 열거합니다. 이 REST API는 ConversationId 및 ActivityId를 사용하여 대화에서 특정 활동의 멤버를 나타내는 ChannelAccount 개체의 배열을 반환합니다.

매개 변수:

conversationId - 대화 ID
activityId - 활동 ID

반환:

List<ChannelAccount> 개체에 대해 관찰할 수 있는 개체입니다.

getConversationMember

public abstract CompletableFuture getConversationMember(String userId, String conversationId)

ID로 대화의 단일 멤버를 검색합니다.

매개 변수:

userId - 사용자 ID입니다.
conversationId - 대화 ID입니다.

반환:

사용자의 ChannelAccount입니다.

getConversationMembers

public abstract CompletableFuture> getConversationMembers(String conversationId)

GetConversationMembers. 대화의 멤버를 열거합니다. 이 REST API는 ConversationId를 사용하고 대화의 멤버를 나타내는 ChannelAccount 개체의 배열을 반환합니다.

매개 변수:

conversationId - 대화 ID

반환:

List<ChannelAccount> 개체에 대해 관찰할 수 있는 개체입니다.

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId)

대화의 멤버를 한 번에 한 페이지씩 열거합니다. 이 REST API는 ConversationId를 사용합니다. 필요에 따라 pageSize 및/또는 continuationToken을 제공할 수 있습니다. 대화의 멤버를 나타내는 ChannelAccounts 배열과 더 많은 값을 가져오는 데 사용할 수 있는 연속 토큰이 포함된 PagedMembersResult를 반환합니다. 각 호출과 함께 ChannelAccounts 레코드의 한 페이지가 반환됩니다. 페이지의 레코드 수는 채널과 호출에 따라 달라질 수 있습니다. 추가 결과가 없으면 응답에 연속 토큰이 포함되지 않습니다. 대화에 멤버가 없으면 멤버가 비어 있거나 응답에 표시되지 않습니다. 이전 요청의 연속 토큰이 있는 요청에 대한 응답은 이전 요청의 멤버를 거의 반환하지 않을 수 있습니다.

매개 변수:

conversationId - 대화 ID

반환:

성공하면 PagedMembersResult 개체입니다.

getConversationPagedMembers

public abstract CompletableFuture getConversationPagedMembers(String conversationId, String continuationToken)

대화의 멤버를 한 번에 한 페이지씩 열거합니다. 이 REST API는 ConversationId를 사용합니다. 필요에 따라 pageSize 및/또는 continuationToken을 제공할 수 있습니다. 대화의 멤버를 나타내는 ChannelAccounts 배열과 더 많은 값을 가져오는 데 사용할 수 있는 연속 토큰이 포함된 PagedMembersResult를 반환합니다. 각 호출과 함께 ChannelAccounts 레코드의 한 페이지가 반환됩니다. 페이지의 레코드 수는 채널과 호출에 따라 달라질 수 있습니다. 추가 결과가 없으면 응답에 연속 토큰이 포함되지 않습니다. 대화에 멤버가 없으면 멤버가 비어 있거나 응답에 표시되지 않습니다. 이전 요청의 연속 토큰이 있는 요청에 대한 응답은 이전 요청의 멤버를 거의 반환하지 않을 수 있습니다.

매개 변수:

conversationId - 대화 ID
continuationToken - 이전 호출의 continuationToken입니다.

반환:

성공하면 PagedMembersResult 개체입니다.

getConversations

public abstract CompletableFuture getConversations()

GetConversations. 이 봇이 참여한 대화를 나열합니다. 건너뛰기 토큰이 있는 이 메서드에서 가져오기 반환 값은 ConversationMembers 배열과 건너뛰기 토큰을 포함하는 ConversationResult입니다. 건너뛰기 토큰이 비어 있지 않으면 반환할 추가 값이 있습니다. 반환된 토큰을 사용하여 이 메서드를 다시 호출하여 더 많은 값을 가져옵니다. 각 ConversationMembers 개체에는 대화의 ID와 대화의 멤버를 설명하는 ChannelAccounts 배열이 포함됩니다.

반환:

ConversationsResult 개체에 대한 관찰 가능 개체

getConversations

public abstract CompletableFuture getConversations(String continuationToken)

GetConversations. 이 봇이 참여한 대화를 나열합니다. 건너뛰기 토큰이 있는 이 메서드에서 가져오기 반환 값은 ConversationMembers 배열과 건너뛰기 토큰을 포함하는 ConversationResult입니다. 건너뛰기 토큰이 비어 있지 않으면 반환할 추가 값이 있습니다. 반환된 토큰을 사용하여 이 메서드를 다시 호출하여 더 많은 값을 가져옵니다. 각 ConversationMembers 개체에는 대화의 ID와 대화의 멤버를 설명하는 ChannelAccounts 배열이 포함됩니다.

매개 변수:

continuationToken - 건너뛰기 또는 연속 토큰

반환:

ConversationsResult 개체에 대한 관찰 가능 개체

replyToActivity

public default CompletableFuture replyToActivity(Activity activity)

ReplyToActivity. 이 메서드를 사용하면 활동에 회신할 수 있습니다. SendToConversation()과 약간 다릅니다. SendToConversation(conversationId) - 채널의 타임스탬프 또는 의미 체계에 따라 대화 끝에 활동을 추가합니다. ReplyToActivity(conversationId,ActivityId) - 채널이 지원하는 경우 활동을 다른 활동에 대한 회신으로 추가합니다. 채널이 중첩된 회신을 지원하지 않는 경우 ReplyToActivity는 SendToConversation으로 돌아갑니다. 대화의 특정 활동에 회신할 때 ReplyToActivity를 사용합니다. 다른 모든 경우에 SendToConversation을 사용합니다.

매개 변수:

activity - 보낼 활동

반환:

ResourceResponse 개체에 대해 관찰할 수 있는 개체

replyToActivity

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

ReplyToActivity. 이 메서드를 사용하면 활동에 회신할 수 있습니다. SendToConversation()과 약간 다릅니다. SendToConversation(conversationId) - 채널의 타임스탬프 또는 의미 체계에 따라 대화 끝에 활동을 추가합니다. ReplyToActivity(conversationId,ActivityId) - 채널이 지원하는 경우 활동을 다른 활동에 대한 회신으로 추가합니다. 채널이 중첩된 회신을 지원하지 않는 경우 ReplyToActivity는 SendToConversation으로 돌아갑니다. 대화의 특정 활동에 회신할 때 ReplyToActivity를 사용합니다. 다른 모든 경우에 SendToConversation을 사용합니다.

매개 변수:

conversationId - 대화 ID
activityId - activityId 회신(선택 사항)
activity - 보낼 활동

반환:

ResourceResponse 개체에 대해 관찰할 수 있는 개체

sendConversationHistory

public abstract CompletableFuture sendConversationHistory(String conversationId, Transcript history)

이 메서드를 사용하면 대화에 기록 활동을 업로드할 수 있습니다. 보낸 사람은 기록 활동에 고유한 ID와 적절한 타임스탬프가 있는지 확인해야 합니다. ID는 클라이언트에서 중복 작업을 처리하는 데 사용되며 타임스탬프는 클라이언트가 작업을 올바른 순서로 렌더링하는 데 사용됩니다.

매개 변수:

conversationId - 대화 ID
history - 역사적인 활동

반환:

성공하면 ResourceResponse 개체입니다.

sendToConversation

public default CompletableFuture sendToConversation(Activity activity)

SendToConversation. 이 메서드를 사용하면 대화가 끝날 때까지 활동을 보낼 수 있습니다. ReplyToActivity()와 약간 다릅니다. sendToConverstion(activity) - 대화 ID에 Activity.getConversation.getId를 사용하여 채널의 타임스탬프 또는 의미 체계에 따라 대화 끝에 활동을 추가합니다. replyToActivity(conversationId,ActivityId) - 채널이 지원하는 경우 다른 활동에 회신으로 활동을 추가합니다. 채널이 중첩된 회신을 지원하지 않는 경우 ReplyToActivity는 SendToConversation으로 돌아갑니다. 대화의 특정 활동에 회신할 때 ReplyToActivity를 사용합니다. 다른 모든 경우에 SendToConversation을 사용합니다.

매개 변수:

activity - 보낼 활동

반환:

ResourceResponse 개체에 대해 관찰할 수 있는 개체

sendToConversation

public abstract CompletableFuture sendToConversation(String conversationId, Activity activity)

SendToConversation. 이 메서드를 사용하면 대화가 끝날 때까지 활동을 보낼 수 있습니다. ReplyToActivity()와 약간 다릅니다. SendToConverstion(conversationId) - 채널의 타임스탬프 또는 의미 체계에 따라 대화 끝에 활동을 추가합니다. ReplyToActivity(conversationId,ActivityId) - 채널이 지원하는 경우 활동을 다른 활동에 대한 회신으로 추가합니다. 채널이 중첩된 회신을 지원하지 않는 경우 ReplyToActivity는 SendToConversation으로 돌아갑니다. 대화의 특정 활동에 회신할 때 ReplyToActivity를 사용합니다. 다른 모든 경우에 SendToConversation을 사용합니다.

매개 변수:

conversationId - 대화 ID
activity - 보낼 활동

반환:

ResourceResponse 개체에 대해 관찰할 수 있는 개체

updateActivity

public default CompletableFuture updateActivity(Activity activity)

UpdateActivity. 기존 활동을 편집합니다. 일부 채널을 사용하면 기존 활동을 편집하여 봇 대화의 새 상태를 반영할 수 있습니다. 예를 들어 누군가가 "승인" 단추를 클릭한 후 단추를 제거할 수 있습니다.

매개 변수:

activity - 대체 작업

반환:

ResourceResponse 개체에 대해 관찰할 수 있는 개체

updateActivity

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

UpdateActivity. 기존 활동을 편집합니다. 일부 채널을 사용하면 기존 활동을 편집하여 봇 대화의 새 상태를 반영할 수 있습니다. 예를 들어 누군가가 "승인" 단추를 클릭한 후 단추를 제거할 수 있습니다.

매개 변수:

conversationId - 대화 ID
activityId - 업데이트할 activityId
activity - 대체 작업

반환:

ResourceResponse 개체에 대해 관찰할 수 있는 개체

uploadAttachment

public abstract CompletableFuture uploadAttachment(String conversationId, AttachmentData attachmentUpload)

UploadAttachment. 채널의 Blob Storage에 직접 첨부 파일을 업로드합니다. 이는 엔터프라이즈를 처리할 때 규격 저장소에 데이터를 저장할 수 있기 때문에 유용합니다. 응답은 첨부 파일 API와 함께 사용하기에 적합한 AttachmentId를 포함하는 ResourceResponse입니다.

매개 변수:

conversationId - 대화 ID
attachmentUpload - 첨부 파일 데이터

반환:

ResourceResponse 개체에 대해 관찰할 수 있는 개체

적용 대상