BotAdapter 클래스

패키지:

com.microsoft.bot.builder

Maven 아티팩트:

com.microsoft.bot:bot-builder:4.14.3

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

public abstract class BotAdapter

서비스 엔드포인트에 봇을 연결할 수 있는 봇 어댑터를 나타냅니다. 이 클래스는 추상입니다.

봇 어댑터는 인증 프로세스를 캡슐화하고 Bot Connector Service에서 활동을 보내고 받습니다. 봇이 작업을 받으면 어댑터는 컨텍스트 개체를 만들고, 봇의 애플리케이션 논리에 전달하고, 응답을 사용자의 채널로 다시 보냅니다.

use(Middleware middleware) 사용하여 어댑터\u2019미들웨어 컬렉션에 Middleware 개체를 추가합니다. 어댑터는 봇 미들웨어 파이프라인을 통해 들어오는 작업을 처리하고 봇\u2019논리로 전달한 다음 다시 내보낼 수 있습니다. 각 활동이 봇 내/외부로 흐르면 미들웨어의 각 조각은 봇 논리 실행 전후에 작업을 검사하거나 작업할 수 있습니다.

TurnContext Activity Bot Middleware

필드 요약

한정자 및 형식	필드 및 설명
static final java.lang.String	BOT_IDENTITY_KEY 봇 클레임 ID를 저장하는 키입니다.
static final java.lang.String	OAUTH_CLIENT_KEY 봇 oauth 클라이언트를 저장하는 키입니다.
static final java.lang.String	OAUTH_SCOPE_KEY 봇 oauth 범위를 저장하는 키입니다.

생성자 요약

생성자	Description
BotAdapter()

메서드 요약

한정자 및 형식	메서드 및 설명
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback) 대화에 자동 관리 메시지를 보냅니다.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback) 대화에 자동 관리 메시지를 보냅니다.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback) 대화에 자동 관리 메시지를 보냅니다.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback) 대화에 자동 관리 메시지를 보냅니다.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback) 대화에 자동 관리 메시지를 보냅니다.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) 대화에 자동 관리 메시지를 보냅니다.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(TurnContext context, ConversationReference reference) 파생 클래스에서 재정의되는 경우 대화의 기존 활동을 삭제합니다.
protected MiddlewareSet	getMiddlewareSet() 어댑터 파이프라인의 미들웨어 컬렉션을 가져옵니다.
OnTurnErrorHandler	getOnTurnError() 미들웨어 또는 애플리케이션에서 예외를 catch할 수 있는 오류 처리기를 가져옵니다.
protected java.util.concurrent.CompletableFuture<java.lang.Void>	runPipeline(TurnContext context, BotCallbackHandler callback) 현재 봇 턴에 대한 작업 처리를 시작합니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(TurnContext context, List<Activity> activities) 파생 클래스에서 재정의된 경우 활동을 대화로 보냅니다.
void	setOnTurnError(OnTurnErrorHandler withTurnError) 미들웨어 또는 애플리케이션에서 예외를 catch할 수 있는 오류 처리기를 설정합니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(TurnContext context, Activity activity) 파생 클래스에서 재정의되는 경우 대화의 기존 활동을 바꿉니다.
BotAdapter	use(Middleware middleware) 어댑터의 파이프라인에 미들웨어를 추가합니다.

다음에서 상속된 메서드 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

필드 세부 정보

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

봇 클레임 ID를 저장하는 키입니다.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

봇 oauth 클라이언트를 저장하는 키입니다.

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

봇 oauth 범위를 저장하는 키입니다.

생성자 세부 정보

BotAdapter

public BotAdapter()

메서드 세부 정보

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

대화에 자동 관리 메시지를 보냅니다.

대화에 메시지를 사전에 보내려면 이 메서드를 호출합니다. 대부분의 채널에서는 봇이 사용자에게 활동을 보내기 전에 사용자가 봇과 대화를 시작해야 합니다.

매개 변수:

claimsIdentity - 대화에 대한 ClaimsIdentity입니다.

continuationActivity - 대화를 계속할 적절한 ConversationReference가 있는 활동입니다.

callback - 결과 봇 턴을 호출할 메서드입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

대화에 자동 관리 메시지를 보냅니다.

대화에 메시지를 사전에 보내려면 이 메서드를 호출합니다. 대부분의 채널에서는 봇이 사용자에게 활동을 보내기 전에 사용자가 봇과 대화를 시작해야 합니다.

매개 변수:

claimsIdentity - 대화에 대한 ClaimsIdentity입니다.

continuationActivity - 대화를 계속할 적절한 ConversationReference가 있는 활동입니다.

audience - 자동 관리 메시지의 받는 사람을 나타내는 값입니다.

callback - 결과 봇 턴을 호출할 메서드입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

대화에 자동 관리 메시지를 보냅니다.

대화에 메시지를 사전에 보내려면 이 메서드를 호출합니다. 대부분의 채널에서는 봇이 사용자에게 활동을 보내기 전에 사용자가 봇과 대화를 시작해야 합니다.

매개 변수:

claimsIdentity - 대화에 대한 ClaimsIdentity 참조입니다.

reference - 계속할 대화에 대한 참조입니다.

callback - 결과 봇 턴을 호출할 메서드입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

대화에 자동 관리 메시지를 보냅니다.

대화에 메시지를 사전에 보내려면 이 메서드를 호출합니다. 대부분의 채널에서는 봇이 사용자에게 활동을 보내기 전에 사용자가 봇과 대화를 시작해야 합니다.

매개 변수:

claimsIdentity - 대화에 대한 ClaimsIdentity 참조입니다.

reference - 계속할 대화에 대한 참조입니다.

audience - 자동 관리 메시지의 받는 사람을 나타내는 값입니다.

callback - 결과 봇 턴을 호출할 메서드입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

대화에 자동 관리 메시지를 보냅니다.

대화에 메시지를 사전에 보내려면 이 메서드를 호출합니다. 대부분의 채널에서는 봇이 사용자에게 활동을 보내기 전에 사용자가 봇과 대화를 시작해야 합니다.

매개 변수:

botId - 봇의 애플리케이션 ID입니다. 이 매개 변수는 어댑터(콘솔, 테스트 등)의 단일 테넌트에서 무시되지만 다중 테넌트 인식인 BotFrameworkAdapter에 중요합니다.

continuationActivity - 대화를 계속할 적절한 ConversationReference가 있는 활동입니다.

callback - 결과 봇 턴을 호출할 메서드입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

대화에 자동 관리 메시지를 보냅니다.

매개 변수:

botAppId - 봇의 애플리케이션 ID입니다. 이 매개 변수는 어댑터(콘솔, 테스트 등)의 단일 테넌트에서 무시되지만 다중 테넌트 인식인 BotFrameworkAdapter에 중요합니다.

reference - 계속할 대화에 대한 참조입니다.

callback - 결과 봇 턴을 호출할 메서드입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 대화에 메시지를 사전에 보내려면 이 메서드를 호출합니다. 대부분의 채널에서는 봇이 사용자에게 활동을 보내기 전에 사용자가 봇과 대화를 시작해야 합니다.

     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

파생 클래스에서 재정의되는 경우 대화의 기존 활동을 삭제합니다.

매개 변수:

context - 순서에 대한 컨텍스트 개체입니다.

reference - 삭제할 활동에 대한 대화 참조입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 대화 참조의 ConversationReference#getActivityId 삭제할 활동을 식별합니다. onDeleteActivity(DeleteActivityHandler handler)

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

어댑터 파이프라인의 미들웨어 컬렉션을 가져옵니다.

반환:

파이프라인에 대한 미들웨어 컬렉션입니다.

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

미들웨어 또는 애플리케이션에서 예외를 catch할 수 있는 오류 처리기를 가져옵니다.

반환:

미들웨어 또는 애플리케이션에서 예외를 catch할 수 있는 오류 처리기입니다.

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

현재 봇 턴에 대한 작업 처리를 시작합니다. 어댑터는 미들웨어를 추가한 순서대로 호출합니다. 어댑터는 순서 및 다음 대리자의 컨텍스트 개체를 전달하고 미들웨어는 대리자를 호출하여 파이프라인의 다음 미들웨어에 제어를 전달합니다. 컨트롤이 파이프라인의 끝에 도달하면 어댑터는 callback 메서드를 호출합니다. 미들웨어 구성 요소가 다음 대리자를 호출하지 않으면 어댑터는 후속 미들웨어\u2019onTurn(TurnContext turnContext, NextDelegate next) 메서드 또는 콜백 메서드 및 파이프라인 단락을 호출하지 않습니다.

사용자 활동(사후 메시징)에 의해 턴이 시작되면 콜백 메서드는 봇의 onTurn(TurnContext turnContext) 메서드에 대한 참조가 됩니다. continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) 호출(자동 관리 메시징)에 의해 턴이 시작되면 콜백 메서드는 호출에서 제공된 콜백 메서드입니다.

매개 변수:

context - 턴의 컨텍스트 개체입니다.

callback - 파이프라인의 끝에서 실행할 콜백 메서드입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

파생 클래스에서 재정의된 경우 활동을 대화로 보냅니다.

매개 변수:

context - 순서에 대한 컨텍스트 개체입니다.

activities - 보낼 활동입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 작업이 성공적으로 전송되면 작업 결과에는 수신 채널이 활동에 할당한 ID를 포함하는 ResourceResponse 개체의 배열이 포함됩니다. onSendActivities(SendActivitiesHandler handler)

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

미들웨어 또는 애플리케이션에서 예외를 catch할 수 있는 오류 처리기를 설정합니다.

매개 변수:

withTurnError - 미들웨어 또는 애플리케이션에서 예외를 catch할 수 있는 오류 처리기입니다.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

파생 클래스에서 재정의되는 경우 대화의 기존 활동을 바꿉니다.

매개 변수:

context - 순서에 대한 컨텍스트 개체입니다.

activity - 새 대체 작업입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 작업이 성공적으로 전송되면 작업 결과에는 수신 채널이 작업에 할당한 ID를 포함하는 ResourceResponse 개체가 포함됩니다.

이를 호출하기 전에 대체 활동의 ID를 바꿀 활동의 ID로 설정합니다. onUpdateActivity(UpdateActivityHandler handler)

use

public BotAdapter use(Middleware middleware)

어댑터의 파이프라인에 미들웨어를 추가합니다.

매개 변수:

middleware - 추가할 미들웨어입니다.

반환:

업데이트된 어댑터 개체입니다. 미들웨어는 초기화 시 어댑터에 추가됩니다. 각 턴에 대해 어댑터는 추가한 순서대로 미들웨어를 호출합니다.