TurnContext 인터페이스

패키지:

com.microsoft.bot.builder

Maven 아티팩트:

com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

봇의 턴에 대한 컨텍스트를 제공합니다.

컨텍스트는 들어오는 작업을 처리하는 데 필요한 정보를 제공합니다. 컨텍스트 개체는 BotAdapter 의해 만들어지고 턴의 길이 동안 유지됩니다.

Bot Middleware

필드 요약

한정자 및 형식	필드 및 설명
static final java.lang.String	STATE_TURN_LOCALE

메서드 요약

한정자 및 형식	메서드 및 설명
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(ConversationReference conversationReference) 기존 활동을 삭제합니다.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(String activityId) 기존 활동을 삭제합니다.
abstract Activity	getActivity() 봇의 이 턴에 대한 활동을 가져옵니다.
abstract BotAdapter	getAdapter() 이 컨텍스트 개체를 만든 봇 어댑터를 가져옵니다.
abstract java.lang.String	getLocale() 이 컨텍스트 개체의 로캘을 가져옵니다.
abstract boolean	getResponded() 현재 턴에 대해 하나 이상의 응답을 보냈는지 여부를 나타내는 값을 가져옵니다.
abstract TurnContextStateCollection	getTurnState() 턴의 수명 동안 컨텍스트 개체와 함께 캐시된 값의 컬렉션을 가져옵니다.
abstract TurnContext	onDeleteActivity(DeleteActivityHandler handler) 작업 삭제 작업에 대한 응답 처리기를 추가합니다.
abstract TurnContext	onSendActivities(SendActivitiesHandler handler) 보내기 작업 작업에 대한 응답 처리기를 추가합니다.
abstract TurnContext	onUpdateActivity(UpdateActivityHandler handler) 업데이트 작업 작업에 대한 응답 처리기를 추가합니다.
default java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(Activity[] activities) 활동 배열을 보내는 도우미 메서드입니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) 들어오는 활동의 보낸 사람에게 활동 목록을 보냅니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activity) 들어오는 활동의 보낸 사람에게 활동을 보냅니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) 들어오는 활동의 보낸 사람에게 메시지 활동을 보냅니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) 들어오는 활동의 보낸 사람에게 메시지 활동을 보냅니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak, InputHints inputHint) 들어오는 활동의 보낸 사람에게 메시지 활동을 보냅니다.
default java.util.concurrent.CompletableFuture<java.lang.Void>	sendActivityBlind(Activity activity) 리소스응답을 반환하지 않고 들어오는 활동의 보낸 사람에게 활동을 보냅니다.
abstract void	setLocale(String withLocale) 이 컨텍스트 개체에서 로캘을 설정합니다.
static java.util.concurrent.CompletableFuture<ResourceResponse>	traceActivity(TurnContext turnContext, String name)
static java.util.concurrent.CompletableFuture<ResourceResponse>	traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label) 로깅을 위해 추적 작업을 BotAdapter 보냅니다.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) 기존 활동을 대체합니다.

필드 세부 정보

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

메서드 세부 정보

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

기존 활동을 삭제합니다.

매개 변수:

conversationReference - 삭제할 활동이 포함된 대화입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 대화 참조의 ConversationReference#getActivityId 삭제할 대화의 활동을 나타냅니다.

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

기존 활동을 삭제합니다.

매개 변수:

activityId - 삭제할 활동의 ID입니다.

반환:

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

getActivity

public abstract Activity getActivity()

봇의 이 턴에 대한 활동을 가져옵니다.

반환:

봇의 이 턴에 대한 활동입니다.

getAdapter

public abstract BotAdapter getAdapter()

이 컨텍스트 개체를 만든 봇 어댑터를 가져옵니다.

반환:

이 컨텍스트 개체를 만든 봇 어댑터입니다.

getLocale

public abstract String getLocale()

이 컨텍스트 개체의 로캘을 가져옵니다.

반환:

이 컨텍스트 개체의 로캘 문자열입니다.

getResponded

public abstract boolean getResponded()

현재 턴에 대해 하나 이상의 응답을 보냈는지 여부를 나타내는 값을 가져옵니다.

반환:

현재 턴에 대해 하나 이상의 응답이 전송되었는지 true. 그렇지 않으면 false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

턴의 수명 동안 컨텍스트 개체와 함께 캐시된 값의 컬렉션을 가져옵니다.

반환:

이 컨텍스트 개체에 등록된 서비스의 컬렉션입니다.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

작업 삭제 작업에 대한 응답 처리기를 추가합니다.

컨텍스트의 deleteActivity(String activityId) 호출되면 어댑터는 등록된 처리기를 컨텍스트 개체에 추가된 순서대로 호출합니다.

매개 변수:

handler - 컨텍스트 개체에 추가할 처리기입니다.

반환:

업데이트된 컨텍스트 개체입니다.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

보내기 작업 작업에 대한 응답 처리기를 추가합니다.

컨텍스트의 sendActivity(Activity activity) 또는 sendActivities(List<Activity> activities) 메서드가 호출되면 어댑터는 등록된 처리기를 컨텍스트 개체에 추가된 순서대로 호출합니다.

매개 변수:

handler - 컨텍스트 개체에 추가할 처리기입니다.

반환:

업데이트된 컨텍스트 개체입니다.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

업데이트 작업 작업에 대한 응답 처리기를 추가합니다.

컨텍스트의 updateActivity(Activity withActivity) 호출되면 어댑터는 등록된 처리기를 컨텍스트 개체에 추가된 순서대로 호출합니다.

매개 변수:

handler - 컨텍스트 개체에 추가할 처리기입니다.

반환:

업데이트된 컨텍스트 개체입니다.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

활동 배열을 보내는 도우미 메서드입니다. sendActivities(List<Activity> activities)호출합니다.

매개 변수:

activities - 활동의 배열입니다.

반환:

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

sendActivities

public abstract CompletableFuture sendActivities(List activities)

들어오는 활동의 보낸 사람에게 활동 목록을 보냅니다.

작업이 성공적으로 전송되면 작업 결과에는 수신 채널이 활동에 할당한 ID를 포함하는 ResourceResponse 개체의 배열이 포함됩니다.

매개 변수:

activities - 보낼 활동입니다.

반환:

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

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

들어오는 활동의 보낸 사람에게 활동을 보냅니다.

매개 변수:

activity - 보낼 활동입니다.

반환:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

들어오는 활동의 보낸 사람에게 메시지 활동을 보냅니다.

작업이 성공적으로 전송되면 작업 결과에는 수신 채널이 작업에 할당한 ID를 포함하는 ResourceResponse 개체가 포함됩니다.

textReplyToSend콘텐츠에 적용되는 제한은 채널 설명서를 참조하세요.

매개 변수:

textReplyToSend - 보낼 메시지의 텍스트입니다.

반환:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

들어오는 활동의 보낸 사람에게 메시지 활동을 보냅니다.

작업이 성공적으로 전송되면 작업 결과에는 수신 채널이 작업에 할당한 ID를 포함하는 ResourceResponse 개체가 포함됩니다.

textReplyToSend콘텐츠에 적용되는 제한은 채널 설명서를 참조하세요.

음성, 속도, 볼륨, 발음 및 피치와 같은 봇 음성의 다양한 특성을 제어하려면 SSML(Speech Synthesis Markup Language) 형식으로 speak 지정합니다.

매개 변수:

textReplyToSend - 보낼 메시지의 텍스트입니다.

speak - 선택 사항으로, 음성 지원 채널에서 봇이 말할 텍스트입니다.

반환:

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak, InputHints inputHint)

들어오는 활동의 보낸 사람에게 메시지 활동을 보냅니다.

작업이 성공적으로 전송되면 작업 결과에는 수신 채널이 작업에 할당한 ID를 포함하는 ResourceResponse 개체가 포함됩니다.

textReplyToSend콘텐츠에 적용되는 제한은 채널 설명서를 참조하세요.

음성, 속도, 볼륨, 발음 및 피치와 같은 봇 음성의 다양한 특성을 제어하려면 SSML(Speech Synthesis Markup Language) 형식으로 speak 지정합니다.

매개 변수:

textReplyToSend - 보낼 메시지의 텍스트입니다.

speak - 선택 사항으로, 음성 지원 채널에서 봇이 말할 텍스트입니다.

inputHint - 선택 사항으로, 메시지가 클라이언트에 전달된 후 봇이 사용자 입력을 수락, 예상 또는 무시할지 여부를 나타냅니다. "acceptingInput", "ignoringInput" 또는 "expectingInput" 중 하나입니다. 기본값은 "acceptingInput"입니다.

반환:

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

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

ResourceResponse를 반환하지 않고 들어오는 활동의 보낸 사람에게 활동을 보냅니다.

매개 변수:

activity - 보낼 활동입니다.

반환:

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

setLocale

public abstract void setLocale(String withLocale)

이 컨텍스트 개체에서 로캘을 설정합니다.

매개 변수:

withLocale - 이 컨텍스트 개체의 로캘 문자열입니다.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

매개 변수:

turnContext - turnContext입니다.

name - 활동의 이름입니다.

반환:

ResourceReponse의 미래입니다.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

로깅을 위해 추적 작업을 BotAdapter 보냅니다.

매개 변수:

turnContext - 현재 턴의 컨텍스트입니다.

name - 활동의 Activity#getName 속성에 할당할 값입니다.

value - 활동의 Activity#getValue 속성에 할당할 값입니다.

valueType - 활동의 Activity#getValueType 속성에 할당할 값입니다.

label - 활동의 Activity#getLabel 속성에 할당할 값입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 어댑터가 에뮬레이터에서 호스트되는 경우 작업 결과에는 원래 추적 작업의 ID가 있는 ResourceResponse 개체가 포함됩니다. 그렇지 않으면 수신 채널이 활동에 할당된 ID를 포함하는 ResourceResponse 개체를 포함합니다.

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

기존 활동을 대체합니다.

작업이 성공적으로 전송되면 작업 결과에는 수신 채널이 작업에 할당한 ID를 포함하는 ResourceResponse 개체가 포함됩니다.

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

매개 변수:

withActivity - 새 대체 작업입니다.

반환:

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