ActivityHandler 클래스
- java.
lang. Object - com.
microsoft. bot. builder. ActivityHandler
- com.
구현
public class ActivityHandler
implements Bot
생성자 요약
생성자 | Description | |
---|---|---|
ActivityHandler() |
메서드 요약
한정자 및 형식 | 메서드 및 설명 |
---|---|
protected
Invoke |
createInvokeResponse(Object body)
지정된 본문을 사용하여 성공 호출 |
protected
java.util.concurrent.CompletableFuture<Adaptive |
onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)
봇이 적응형 카드 동작 실행을 보낼 때 호출됩니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onCommandActivity(TurnContext turnContext)
의 기본 동작이 사용될 때 명령 작업이 onTurn(TurnContext turnContext) 수신될 때 호출됩니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onCommandResultActivity(TurnContext turnContext)
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 명령 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onConversationUpdateActivity(TurnContext turnContext)
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 채널에서 대화 업데이트 작업을 수신할 때 호출됩니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onEndOfConversationActivity(TurnContext turnContext)
활동 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onEvent(TurnContext turnContext)
의 기본 동작 onEventActivity(TurnContext turnContext) 이 사용될 때 토큰/응답 이외의 이벤트가 수신될 때 호출됩니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onEventActivity(TurnContext turnContext)
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 커넥터에서 이벤트 활동을 수신할 때 호출됩니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onInstallationUpdate(TurnContext turnContext)
활동 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onInstallationUpdateAdd(TurnContext turnContext)
활동 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onInstallationUpdateRemove(TurnContext turnContext)
활동 |
protected
java.util.concurrent.CompletableFuture<Invoke |
onInvokeActivity(TurnContext turnContext)
On Turn의 기본 동작 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext)
파생 클래스에서 이를 재정의하여 봇 이외의 멤버가 대화에 참가하는 경우(예: 봇의 시작 논리)에 대한 논리를 제공합니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext)
봇 이외의 멤버가 대화를 종료하는 경우(예: 봇의 good-bye 논리)에 대한 논리를 제공하려면 파생 클래스에서 이를 재정의합니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onMessageActivity(TurnContext turnContext)
파생 클래스에서 이를 재정의하여 대화형 논리와 같은 활동에 특정 ActivityTypes#MESSAGE 한 논리를 제공합니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onMessageReactionActivity(TurnContext turnContext)
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 커넥터에서 이벤트 활동을 수신할 때 호출됩니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext)
파생 클래스에서 이를 재정의하여 이전 활동에 대한 반응이 대화에 추가되는 경우에 대한 논리를 제공합니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext)
파생 클래스에서 이를 재정의하여 이전 활동에 대한 반응이 대화에서 제거되는 경우에 대한 논리를 제공합니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onSignInInvoke(TurnContext turnContext)
Invoke |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onTokenResponseEvent(TurnContext turnContext)
의 기본 동작 onEventActivity(TurnContext turnContext) 이 사용될 때 "토큰/응답" 이벤트가 수신될 때 호출됩니다. |
java.util.concurrent.CompletableFuture<java.lang.Void> |
onTurn(TurnContext turnContext)
인바운드 Activity를 처리하기 위해 런타임 시 어댑터(예BotFrameworkAdapter: )에 의해 호출됩니다. |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onTypingActivity(TurnContext turnContext)
활동 |
protected java.util.concurrent.CompletableFuture<java.lang.Void> |
onUnrecognizedActivityType(TurnContext turnContext)
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 메시지, 대화 업데이트 또는 이벤트 이외의 활동이 수신될 때 호출됩니다. |
다음에서 상속된 메서드 java.lang.Object
생성자 세부 정보
ActivityHandler
public ActivityHandler()
메서드 세부 정보
createInvokeResponse
protected InvokeResponse createInvokeResponse(Object body)
지정된 본문을 사용하여 Success InvokeResponse를 만듭니다.
매개 변수:
반환:
onAdaptiveCardInvoke
protected CompletableFuture
봇이 적응형 카드 동작 실행을 보낼 때 호출됩니다.
매개 변수:
반환:
adaptiveCard/action
를 사용하여 Invoke를 받으면 이 메서드를 InvokeActivity.name 호출합니다.onCommandActivity
protected CompletableFuture
의 기본 동작이 사용될 때 명령 작업이 onTurn(TurnContext turnContext) 수신될 때 호출됩니다. 명령은 작업을 수행하기 위한 요청이며 수신기는 일반적으로 하나 이상의 commandResult 작업으로 응답합니다. 또한 수신기는 지원되지 않는 명령 작업을 명시적으로 거부해야 합니다.
매개 변수:
반환:
onCommandResultActivity
protected CompletableFuture
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 CommandResult 작업이 수신될 때 호출됩니다. CommandResult 작업을 사용하여 명령 실행 결과를 전달할 수 있습니다.
매개 변수:
반환:
onConversationUpdateActivity
protected CompletableFuture
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 채널에서 대화 업데이트 작업을 수신할 때 호출됩니다.
대화 업데이트 활동은 대화에 추가되거나 제거되는 사용자에 응답할 때 유용합니다.
예를 들어 봇은 사용자에게 인사말을 하여 추가되는 사용자에게 응답할 수 있습니다. 기본적으로 이 메서드는 사용자가 추가되었거나 onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext) 사용자가 제거된 경우 를 호출 onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext) 합니다. 메서드는 멤버 ID를 확인하여 봇 자체 이외의 멤버에 대한 업데이트에만 응답합니다.
매개 변수:
반환:
onEndOfConversationActivity
protected CompletableFuture
파생 클래스에서 이를 재정의하여 ActivityTypes.END_OF_CONVERSATION 활동과 관련된 논리를 제공합니다.
매개 변수:
반환:
onEvent
protected CompletableFuture
의 기본 동작 onEventActivity(TurnContext turnContext) 이 사용될 때 토큰/응답 이외의 이벤트가 수신될 때 호출됩니다.
봇이 기타 이벤트를 처리하려는 경우 이 메서드를 선택적으로 재정의할 수 있습니다.
기본적으로 이 메서드는 아무것도 수행하지 않습니다.
메서드가 onEventActivity(TurnContext turnContext) '토큰/응답' 이외의 를 사용하여 Activity#getName() 이벤트를 수신하면 이 메서드를 호출합니다.
매개 변수:
반환:
onEventActivity
protected CompletableFuture
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 커넥터에서 이벤트 활동을 수신할 때 호출됩니다.
이벤트 활동을 사용하여 다양한 내용을 전달할 수 있습니다.
기본적으로 이 메서드는 활동의 이름이 "토큰/응답" 또는 onEvent(TurnContext turnContext) 다른 경우 를 호출 onTokenResponseEvent(TurnContext turnContext) 합니다. "tokens/response" 이벤트는 에 의해 com.microsoft.bot.schema.OAuthCard트리거될 수 있습니다.
메서드가 onTurn(TurnContext turnContext) 이벤트 작업을 수신하면 이 메서드를 호출합니다.
이벤트가 Activity#getName '토큰/응답'이면 를 호출 onTokenResponseEvent(TurnContext turnContext) 하고, 그렇지 않으면 를 호출합니다 onEvent(TurnContext turnContext).
파생 클래스에서 이 메서드를 재정의하여 모든 이벤트 활동에 적용되는 논리를 추가합니다. 기본 클래스 메서드를 호출하기 전에 특정 이벤트 처리 논리 앞에 적용할 논리를 추가합니다. 기본 클래스 메서드를 호출한 후 특정 이벤트 처리 논리 다음에 적용할 논리를 추가합니다.
이벤트 활동은 클라이언트 또는 채널에서 봇으로 프로그래밍 방식의 정보를 전달합니다. 이벤트 활동의 의미는 채널 범위 내에서 의미 있는 속성에 의해 Activity#getName 정의됩니다. '토큰/응답' 이벤트는 또는 OAuth 프롬프트에 의해 com.microsoft.bot.schema.OAuthCard 트리거될 수 있습니다.
매개 변수:
반환:
onInstallationUpdate
protected CompletableFuture
파생 클래스에서 이를 재정의하여 ActivityTypes.InstallationUpdate 작업과 관련된 논리를 제공합니다.
매개 변수:
반환:
onInstallationUpdateAdd
protected CompletableFuture
파생 클래스에서 이를 재정의하여 'action'이 'add'로 설정된 ActivityTypes.InstallationUpdate 작업에 특정한 논리를 제공합니다.
매개 변수:
반환:
onInstallationUpdateRemove
protected CompletableFuture
파생 클래스에서 이를 재정의하여 'action'이 'remove'로 설정된 ActivityTypes.InstallationUpdate 작업과 관련된 논리를 제공합니다.
매개 변수:
반환:
onInvokeActivity
protected CompletableFuture
onTurn의 기본 동작이 사용될 때 커넥터에서 호출 작업을 수신할 때 호출됩니다.
호출 활동을 사용하여 다양한 내용을 전달할 수 있습니다. 기본적으로 이 메서드는 활동의 이름이 'signin/verifyState' 또는 'signin/tokenExchange'인 경우 onSignInInvokeAsync를 호출합니다.
OAuthCard에서 'signin/verifyState' 또는 'signin/tokenExchange' 호출을 트리거할 수 있습니다.
매개 변수:
반환:
onMembersAdded
protected CompletableFuture
파생 클래스에서 이를 재정의하여 봇 이외의 멤버가 대화에 참가하는 경우(예: 봇의 시작 논리)에 대한 논리를 제공합니다.
메서드가 onConversationUpdateActivity(TurnContext turnContext) bo 이외의 한 명 이상의 사용자가 대화에 참가하고 있음을 나타내는 대화 업데이트 작업을 받으면 이 메서드를 호출합니다.
매개 변수:
반환:
onMembersRemoved
protected CompletableFuture
봇 이외의 멤버가 대화를 종료하는 경우(예: 봇의 good-bye 논리)에 대한 논리를 제공하려면 파생 클래스에서 이를 재정의합니다.
메서드가 onConversationUpdateActivity(TurnContext turnContext) 봇 이외의 한 명 이상의 사용자가 대화를 떠나고 있음을 나타내는 대화 업데이트 작업을 받으면 이 메서드를 호출합니다.
매개 변수:
반환:
onMessageActivity
protected CompletableFuture
파생 클래스에서 이를 재정의하여 대화형 논리와 같은 활동에 특정 ActivityTypes#MESSAGE 한 논리를 제공합니다.
메서드가 onTurn(TurnContext turnContext) 메시지 작업을 받으면 이 메서드를 호출합니다.
매개 변수:
반환:
onMessageReactionActivity
protected CompletableFuture
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 커넥터에서 이벤트 활동을 수신할 때 호출됩니다.
메시지 반응은 이전에 보낸 활동에 'like' 또는 'sad' 등(종종 이모지)을 추가하는 사용자에 해당합니다. 메시지 반응은 일부 채널에서만 지원됩니다.
메시지 반응에 해당하는 활동은 replyToId 속성에 표시됩니다. 이 속성의 값은 보내기 호출의 응답으로 봇에 다시 제공된 이전에 보낸 활동의 활동 ID입니다.
메서드가 onTurn(TurnContext turnContext) 메시지 반응 작업을 수신하면 이 메서드를 호출합니다. 메시지 반응이 메시지에 추가되었음을 나타내는 경우 를 호출합니다 onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext). 메시지 반응이 메시지에서 반응이 제거되었음을 나타내는 경우 를 호출합니다 onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext).
파생 클래스에서 이 메서드를 재정의하여 모든 메시지 반응 활동에 적용되는 논리를 추가합니다. 기본 클래스 메서드를 호출하기 전에 추가되거나 제거된 반응 전에 적용할 논리를 추가합니다. 기본 클래스에 대한 호출 후 논리를 추가하거나 제거한 후 적용할 논리를 추가합니다.
매개 변수:
반환:
onReactionsAdded
protected CompletableFuture
파생 클래스에서 이를 재정의하여 이전 활동에 대한 반응이 대화에 추가되는 경우에 대한 논리를 제공합니다.
메시지 반응은 대화에서 이전에 보낸 메시지에 'like' 또는 'sad' 등(종종 이모지)을 추가하는 사용자에 해당합니다. 메시지 반응은 일부 채널에서만 지원됩니다. 메시지가 반응 중인 활동은 활동의 속성으로 Activity#getReplyToId() 식별됩니다. 이 속성의 값은 이전에 보낸 활동의 활동 ID입니다. 봇이 활동을 보내면 채널에서 ID를 할당합니다. 이 ID는 결과의 에서 com.microsoft.bot.schema.ResourceResponse#getId 사용할 수 있습니다.
매개 변수:
반환:
onReactionsRemoved
protected CompletableFuture
파생 클래스에서 이를 재정의하여 이전 활동에 대한 반응이 대화에서 제거되는 경우에 대한 논리를 제공합니다.
메시지 반응은 대화에서 이전에 보낸 메시지에 'like' 또는 'sad' 등(종종 이모지)을 추가하는 사용자에 해당합니다. 메시지 반응은 일부 채널에서만 지원됩니다. 메시지가 반응 중인 활동은 활동의 속성으로 Activity#getReplyToId() 식별됩니다. 이 속성의 값은 이전에 보낸 활동의 활동 ID입니다. 봇이 활동을 보내면 채널에서 ID를 할당합니다. 이 ID는 결과의 에서 com.microsoft.bot.schema.ResourceResponse#getId 사용할 수 있습니다.
매개 변수:
반환:
onSignInInvoke
protected CompletableFuture
onInvokeActivity의 기본 동작을 사용할 때 'signin/verifyState' 또는 'signin/tokenExchange' 이벤트가 수신될 때 호출됩니다.
OAuthPrompt를 사용하는 경우 이 메서드를 재정의하여 이 작업을 현재 대화 상자로 전달합니다. 기본적으로 이 메서드는 아무것도 수행하지 않습니다.
onInvokeActivity 메서드가 이름이 'tokens/response'인 Invoke를 받으면 이 메서드를 호출합니다.
봇이 OAuthPrompt를 사용하는 경우 들어오는 작업을 현재 대화 상자로 전달합니다.
매개 변수:
반환:
onTokenResponseEvent
protected CompletableFuture
의 기본 동작 onEventActivity(TurnContext turnContext) 이 사용될 때 "토큰/응답" 이벤트가 수신될 때 호출됩니다.
OAuthPrompt를 사용하는 경우 이 메서드를 재정의하여 현재 대화 상자로 전달 Activity 합니다.
기본적으로 이 메서드는 아무것도 수행하지 않습니다.
메서드가 onEventActivity(TurnContext turnContext) '토큰/응답'의 를 Activity#getName() 사용하여 이벤트를 수신하면 이 메서드를 호출합니다.
매개 변수:
반환:
onTurn
public CompletableFuture
인바운드 Activity를 처리하기 위해 런타임 시 어댑터(예BotFrameworkAdapter: )에 의해 호출됩니다.
이 메서드는 처리할 활동의 형식에 따라 이 클래스의 다른 메서드를 호출하므로 파생 클래스가 제어된 방식으로 형식별 논리를 제공할 수 있습니다.
파생 클래스에서 이 메서드를 재정의하여 모든 활동 형식에 적용되는 논리를 추가합니다. 기본 클래스 onTurn(TurnContext turnContext) 메서드를 호출하기 전에 형식별 논리 앞에 적용할 논리를 추가합니다. 기본 클래스 onTurn(TurnContext turnContext) 메서드를 호출한 후 형식별 논리 다음에 적용할 논리를 추가합니다.
매개 변수:
반환:
onTypingActivity
protected CompletableFuture
파생 클래스에서 이를 재정의하여 ActivityTypes.Typing 작업과 관련된 논리를 제공합니다.
매개 변수:
반환:
onUnrecognizedActivityType
protected CompletableFuture
의 기본 동작 onTurn(TurnContext turnContext) 이 사용될 때 메시지, 대화 업데이트 또는 이벤트 이외의 활동이 수신될 때 호출됩니다.
재정의된 경우 또는 com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATION와 같은 com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE 다른 작업 유형에 응답할 수 있습니다.
기본적으로 이 메서드는 아무것도 수행하지 않습니다.
메서드가 onTurn(TurnContext turnContext) 메시지, 대화 업데이트, 메시지 반응 또는 이벤트 활동이 아닌 활동을 수신하면 이 메서드를 호출합니다.
매개 변수:
반환: