ChannelServiceHandler 클래스

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

public class ChannelServiceHandler

Bot Framework 프로토콜의 구현에 도움이 되는 클래스입니다.

생성자 요약

생성자 Description
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)

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

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)

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)

활동멤버() 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)

ConversationPagedMembers() API for Skill을 가져옵니다.

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

기술용대화() 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)

기술용대화기록() API를 보냅니다.

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

기술용ToConversation() API를 보냅니다.

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

업데이트작업() API.

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

첨부 파일() 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 구현하는 채널 공급자를 가져옵니다.

반환:

getChannelProvider()로서의 ChannelProvider 값입니다.

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)

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

매개 변수:

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이 직접 메시지(기본 instanceof false)가 아닌 경우 true로 설정됨 * 대화에 포함할 멤버를 포함하는 배열 반환 값은 메시지 페이로드 및 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(문자열 형식)를 사용하고 대화에서 해당 멤버를 제거합니다. 해당 멤버가 대화의 마지막 멤버인 경우 대화도 삭제됩니다.

매개 변수:

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

매개 변수:

claimsIdentity - 봇에 대한 claimsIdentity에는 AudienceClaim, AppIdClaim 및 ServiceUrlClaim이 있어야 합니다.
conversationId - 대화 D.
pageSize - 제안된 페이지 크기입니다.
continuationToken - 연속 토큰입니다.

반환:

응답에 대한 작업입니다.

onGetConversations

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

OnGetConversations() API for Skill. 이 봇이 참여한 대화를 나열하도록 이 메서드를 재정의합니다. 건너뛰기 토큰이 있는 이 메서드에서 가져오기 반환 값은 ConversationMembers 배열과 건너뛰기 토큰을 포함하는 ConversationResult입니다. 건너뛰기 토큰이 비어 있지 않으면 반환할 추가 값이 있습니다. 반환된 토큰을 사용하여 이 메서드를 다시 호출하여 더 많은 값을 가져옵니다. 각 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 회신입니다(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입니다. 이 메서드를 사용하면 대화가 끝날 때까지 활동을 보낼 수 있습니다. 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. 엔터프라이즈를 처리할 때 규격 저장소에 데이터를 저장하도록 이 메서드를 재정의합니다. 응답은 첨부 파일 API와 함께 사용하기에 적합한 AttachmentId를 포함하는 ResourceResponse입니다.

매개 변수:

claimsIdentity - 봇에 대한 claimsIdentity에는 AudienceClaim, AppIdClaim 및 ServiceUrlClaim이 있어야 합니다.
conversationId - 대화 D.
attachmentUpload - 첨부 파일 데이터입니다.

반환:

결과가 포함된 작업입니다.

적용 대상