ActivityHandler class
봇에 대한 이벤트 내보내기 활동 처리기입니다. ActivityHandlerBase를 확장합니다.
- Extends
설명
이벤트 기반 방식으로 들어오는 활동을 처리하기 위한 확장 가능한 클래스를 제공합니다. 각 이벤트 유형에 대해 임의의 처리기 집합을 등록할 수 있습니다.
이벤트에 대한 처리기를 등록하려면 이벤트 메서드 에서 해당 를 사용합니다. 여러 처리기가 이벤트에 대해 등록된 경우 등록된 순서대로 실행됩니다.
이 개체는 들어오는 작업을 처리할 때 일련의 이벤트를 내보냅니다. 처리기는 연속 함수를 호출하지 않음으로써 이벤트의 전파를 중지할 수 있습니다.
이벤트 유형 | 설명 |
---|---|
회전 | 모든 활동에 대해 먼저 내보냅니다. |
형식별 | 하위 형식에 대한 이벤트를 내보내기 전에 특정 활동 형식에 대해 내보냅니다. |
하위 형식 | 활동 콘텐츠를 기반으로 특정 특수 이벤트에 대해 내보냅니다. |
대화 상자 | 최종 활동 처리 이벤트로 내보냅니다. |
예:
const bot = new ActivityHandler();
server.post('/api/messages', (req, res) => {
adapter.processActivity(req, res, async (context) => {
// Route to bot's activity logic.
await bot.run(context);
});
});
bot.onTurn(async (context, next) => {
// Handle a "turn" event.
await context.sendActivity(`${ context.activity.type } activity received.`);
// Continue with further processing.
await next();
})
.onMessage(async (context, next) => {
// Handle a message activity.
await context.sendActivity(`Echo: ${ context.activity.text }`);
// Continue with further processing.
await next();
});
참고 항목
메서드
on |
명령 작업에 대한 활동 이벤트 처리기를 등록합니다. |
on |
CommandResult 작업에 대한 활동 이벤트 처리기를 등록합니다. |
on |
들어오는 모든 대화 업데이트 작업에 대해 내보내는 대화 업데이트 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
들어오는 활동의 마지막 이벤트로 내보내는 대화 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
대화 작업의 끝에 대한 활동 이벤트 처리기를 등록합니다. |
on |
들어오는 모든 이벤트 활동에 대해 내보내는 이벤트 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
installationupdate 작업에 대한 활동 이벤트 처리기를 등록합니다. |
on |
installationupdate add 작업에 대한 활동 이벤트 처리기를 등록합니다. |
on |
installationupdate remove 작업에 대한 활동 이벤트 처리기를 등록합니다. |
on |
대화에 추가된 멤버 를 포함하는 들어오는 대화 업데이트 작업에 대해 내보내는 추가된 멤버 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
대화에서 제거된 멤버를 포함하는 들어오는 대화 업데이트 작업에 대해 내보내진 멤버 제거 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
들어오는 모든 메시지 작업에 대해 내보내는 메시지 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
들어오는 모든 메시지 반응 활동에 대해 내보내는 메시지 반응 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
메시지에 추가된 반응을 설명하는 들어오는 메시지 반응 활동에 대해 내보내는 추가된 반응 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
메시지에서 제거된 반응을 설명하는 들어오는 메시지 반응 활동에 대해 내보낸 제거된 반응 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
들어오는 |
on |
형식에 관계없이 들어오는 모든 활동에 대해 내보내는 턴 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
on |
입력 작업에 대한 활동 이벤트 처리기를 등록 합니다 . |
on |
ActivityHandler가 이벤트 처리기를 제공하지 않는 형식을 사용하여 들어오는 작업에 대해 내보내는 인식할 수 없는 활동 형식 이벤트에 대한 활동 이벤트 처리기를 등록합니다. |
run(Turn |
이벤트 배출 프로세스를 시작하기 위해 호출됩니다. |
메서드 세부 정보
onCommand(BotHandler)
명령 작업에 대한 활동 이벤트 처리기를 등록합니다.
function onCommand(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
Command 이벤트를 처리하려면 onCommand 형식별 이벤트 처리기를 사용합니다.
onCommandResult(BotHandler)
CommandResult 작업에 대한 활동 이벤트 처리기를 등록합니다.
function onCommandResult(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
CommandResult 이벤트를 처리하려면 onCommandResult 형식별 이벤트 처리기를 사용합니다.
onConversationUpdate(BotHandler)
들어오는 모든 대화 업데이트 작업에 대해 내보내는 대화 업데이트 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onConversationUpdate(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
대화 업데이트 활동은 제목, 참가자 또는 기타 채널 관련 정보와 같은 대화 메타데이터의 변경 내용을 설명합니다.
멤버가 대화에 추가되거나 제거될 때를 처리하려면 onMembersAdded 및 onMembersRemoved 하위 형식 이벤트 처리기를 사용합니다.
onDialog(BotHandler)
들어오는 활동의 마지막 이벤트로 내보내는 대화 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onDialog(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
onEndOfConversation(BotHandler)
대화 작업의 끝에 대한 활동 이벤트 처리기를 등록합니다.
function onEndOfConversation(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
이 활동은 일반적으로 기술에서 특정 자식 대화의 끝을 나타내는 기술 호출자에게 전송됩니다.
대화 종료를 처리하려면 onEndOfConversation 형식별 이벤트 처리기를 사용합니다.
onEvent(BotHandler)
들어오는 모든 이벤트 활동에 대해 내보내는 이벤트 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onEvent(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
이벤트 활동은 클라이언트 또는 채널에서 봇으로 프로그래밍 방식의 정보를 전달합니다. 이벤트 활동의 의미는 채널 범위 내에서 의미 있는 활동의 이름 속성에 의해 정의됩니다. 이벤트 활동은 대화형 정보(예: 단추 클릭)와 비대화형 정보(예: 포함된 음성 모델을 자동으로 업데이트하는 클라이언트에 대한 알림)를 둘 다 전달하도록 설계되었습니다.
이벤트 이벤트를 처리 tokens/response
하려면 onTokenResponseEvent 하위 형식 이벤트 처리기를 사용합니다. 다른 명명된 이벤트를 처리하려면 이 처리기에 논리를 추가합니다.
onInstallationUpdate(BotHandler)
installationupdate 작업에 대한 활동 이벤트 처리기를 등록합니다.
function onInstallationUpdate(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
InstallationUpdate 이벤트를 처리하려면 onInstallationUpdate 형식별 이벤트 처리기를 사용합니다.
onInstallationUpdateAdd(BotHandler)
installationupdate add 작업에 대한 활동 이벤트 처리기를 등록합니다.
function onInstallationUpdateAdd(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다. InstallationUpdateAdd 이벤트를 처리하려면 onInstallationUpdateAdd 형식별 이벤트 처리기를 사용합니다.
onInstallationUpdateRemove(BotHandler)
installationupdate remove 작업에 대한 활동 이벤트 처리기를 등록합니다.
function onInstallationUpdateRemove(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
InstallationUpdateRemove 이벤트를 처리하려면 onInstallationUpdateRemove 형식별 이벤트 처리기를 사용합니다.
onMembersAdded(BotHandler)
대화에 추가된 멤버 를 포함하는 들어오는 대화 업데이트 작업에 대해 내보내는 추가된 멤버 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onMembersAdded(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
활동의 membersAdded 속성에는 봇을 포함할 수 있는 대화에 추가된 멤버가 포함됩니다.
일반적으로 대화 업데이트 이벤트를 처리하려면 onConversationUpdate 형식별 이벤트 처리기를 사용합니다.
onMembersRemoved(BotHandler)
대화에서 제거된 멤버를 포함하는 들어오는 대화 업데이트 작업에 대해 내보내진 멤버 제거 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onMembersRemoved(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
활동의 membersRemoved 속성에는 봇을 포함할 수 있는 대화에서 제거된 멤버가 포함됩니다.
일반적으로 대화 업데이트 이벤트를 처리하려면 onConversationUpdate 형식별 이벤트 처리기를 사용합니다.
onMessage(BotHandler)
들어오는 모든 메시지 작업에 대해 내보내는 메시지 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onMessage(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
메시지 활동은 대화형 인터페이스 내에 표시될 콘텐츠를 나타내며 텍스트, 음성, 대화형 카드 및 이진 또는 알 수 없는 첨부 파일을 포함할 수 있습니다.
모든 메시지 활동에 텍스트가 포함된 것은 아니며, 활동의 텍스트 속성은 또는 undefined
일 null
수 있습니다.
onMessageReaction(BotHandler)
들어오는 모든 메시지 반응 활동에 대해 내보내는 메시지 반응 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onMessageReaction(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
메시지 반응 활동은 대화 내에서 기존 메시지 활동에 대한 소셜 상호 작용을 나타냅니다. 원래 활동은 메시지 반응 활동의 replyToId 속성으로 참조됩니다. from 속성은 메시지에 반응한 사용자와 같은 반응의 원본을 나타냅니다.
대화의 메시지에 반응이 추가되거나 제거되는 경우를 처리하려면 onReactionsAdded 및 onReactionsRemoved 하위 형식 이벤트 처리기를 사용합니다.
onReactionsAdded(BotHandler)
메시지에 추가된 반응을 설명하는 들어오는 메시지 반응 활동에 대해 내보내는 추가된 반응 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onReactionsAdded(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
활동의 반응Added 속성에는 추가된 하나 이상의 반응이 포함됩니다.
일반적으로 메시지 반응 이벤트를 처리하려면 onMessageReaction 형식별 이벤트 처리기를 사용합니다.
onReactionsRemoved(BotHandler)
메시지에서 제거된 반응을 설명하는 들어오는 메시지 반응 활동에 대해 내보낸 제거된 반응 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onReactionsRemoved(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
활동의 반응Removed 속성에는 제거된 하나 이상의 반응이 포함됩니다.
일반적으로 메시지 반응 이벤트를 처리하려면 onMessageReaction 형식별 이벤트 처리기를 사용합니다.
onTokenResponseEvent(BotHandler)
들어오는 tokens/response
이벤트 활동에 대해 내보내는 tokens-response 이벤트에 대한 활동 이벤트 처리기를 등록합니다. OAuth 인증 흐름의 일부로 생성됩니다.
function onTokenResponseEvent(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
활동의 값 속성에는 사용자 토큰이 포함됩니다.
봇이 대화 상자 내에서 OAuthPrompt 를 사용하여 인증을 처리하는 경우 이 작업을 수신하여 인증 흐름을 완료해야 합니다.
일반적으로 다른 명명된 이벤트 및 이벤트 이벤트를 처리하려면 onEvent 형식별 이벤트 처리기를 사용합니다.
onTurn(BotHandler)
형식에 관계없이 들어오는 모든 활동에 대해 내보내는 턴 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onTurn(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
onTyping(BotHandler)
입력 작업에 대한 활동 이벤트 처리기를 등록 합니다 .
function onTyping(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
Typing 이벤트를 처리하려면 onTyping 형식별 이벤트 처리기를 사용합니다.
onUnrecognizedActivityType(BotHandler)
ActivityHandler가 이벤트 처리기를 제공하지 않는 형식을 사용하여 들어오는 작업에 대해 내보내는 인식할 수 없는 활동 형식 이벤트에 대한 활동 이벤트 처리기를 등록합니다.
function onUnrecognizedActivityType(handler: BotHandler): this
매개 변수
- handler
- BotHandler
이벤트 처리기입니다.
반환
this
ActivityHandler 개체에 대한 참조입니다.
설명
는 ActivityHandler
Bot Framework 활동 스키마에 정의된 모든 활동 형식에 대한 이벤트를 정의하지 않습니다. 또한 채널 및 사용자 지정 어댑터는 스키마에 없는 형식으로 활동을 만들 수 있습니다. 활동 처리기가 이러한 이벤트를 수신하면 인식할 수 없는 활동 형식 이벤트를 내보낸다.
활동의 형식 속성에는 활동 형식이 포함됩니다.
run(TurnContext)
이벤트 배출 프로세스를 시작하기 위해 호출됩니다.
function run(context: TurnContext): Promise<void>
매개 변수
- context
- TurnContext
현재 턴에 대한 컨텍스트 개체입니다.
반환
Promise<void>
설명
일반적으로 수신된 작업이 어댑터에서 미리 처리되고 미들웨어를 통해 라우팅된 후 어댑터가 봇의 논리를 수행하기 위해 호출하는 함수 처리기로 이 메서드를 제공합니다.
예:
server.post('/api/messages', (req, res) => {
adapter.processActivity(req, res, async (context) => {
// Route to bot's activity logic.
await bot.run(context);
});
});
참고 항목