TurnContext Interface

Pacote:

com.microsoft.bot.builder

Artefato Maven:

com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

Fornece contexto para uma vez de um bot.

O contexto fornece informações necessárias para processar uma atividade de entrada. O objeto de contexto é criado por um BotAdapter e persiste pelo comprimento da curva.

Bot Middleware

Resumo do campo

Modificador e tipo	Campo e descrição
static final java.lang.String	STATE_TURN_LOCALE

Resumo do método

Modificador e tipo	Método e descrição
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(ConversationReference conversationReference) Exclui uma atividade existente.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(String activityId) Exclui uma atividade existente.
abstract Activity	getActivity() Obtém a atividade desta vez do bot.
abstract BotAdapter	getAdapter() Obtém o adaptador de bot que criou esse objeto de contexto.
abstract java.lang.String	getLocale() Obtém a localidade neste objeto de contexto.
abstract boolean	getResponded() Obtém um valor que indica se pelo menos uma resposta foi enviada para a curva atual.
abstract TurnContextStateCollection	getTurnState() Obtém a coleção de valores armazenados em cache com o objeto de contexto durante o tempo de vida da curva.
abstract TurnContext	onDeleteActivity(DeleteActivityHandler handler) Adiciona um manipulador de resposta para operações de atividade de exclusão.
abstract TurnContext	onSendActivities(SendActivitiesHandler handler) Adiciona um manipulador de resposta para operações de atividade de envio.
abstract TurnContext	onUpdateActivity(UpdateActivityHandler handler) Adiciona um manipulador de resposta para operações de atividade de atualização.
default java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(Activity[] activities) Método auxiliar para enviar uma matriz de Atividades.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) Envia uma lista de atividades para o remetente da atividade de entrada.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activity) Envia uma atividade para o remetente da atividade de entrada.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) Envia uma atividade de mensagem para o remetente da atividade de entrada.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) Envia uma atividade de mensagem para o remetente da atividade de entrada.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak, InputHints inputHint) Envia uma atividade de mensagem para o remetente da atividade de entrada.
default java.util.concurrent.CompletableFuture<java.lang.Void>	sendActivityBlind(Activity activity) Envia uma atividade para o remetente da Atividade de entrada sem retornar um RecursoResposta.
abstract void	setLocale(String withLocale) Defina a localidade neste objeto de contexto.
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) Envia uma atividade de rastreamento para o BotAdapter para fins de registro em log.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) Substitui uma atividade existente.

Detalhes do campo

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

Detalhes do método

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

Exclui uma atividade existente.

Parâmetros:

conversationReference - A conversa que contém a atividade a ser excluída.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. O ConversationReference#getActivityId da referência de conversa indica a atividade na conversa a ser excluída.

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

Exclui uma atividade existente.

Parâmetros:

activityId - A ID da atividade a ser excluída.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

getActivity

public abstract Activity getActivity()

Obtém a atividade desta vez do bot.

Retornos:

A atividade para essa virada do bot.

getAdapter

public abstract BotAdapter getAdapter()

Obtém o adaptador de bot que criou esse objeto de contexto.

Retornos:

O adaptador de bot que criou esse objeto de contexto.

getLocale

public abstract String getLocale()

Obtém a localidade neste objeto de contexto.

Retornos:

A cadeia de caracteres de localidade neste objeto de contexto.

getResponded

public abstract boolean getResponded()

Obtém um valor que indica se pelo menos uma resposta foi enviada para a curva atual.

Retornos:

true se pelo menos uma resposta foi enviada para a curva atual; caso contrário, false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

Obtém a coleção de valores armazenados em cache com o objeto de contexto durante o tempo de vida da curva.

Retornos:

A coleção de serviços registrados neste objeto de contexto.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Adiciona um manipulador de resposta para operações de atividade de exclusão.

Quando o deleteActivity(String activityId) do contexto é chamado, o adaptador chama os manipuladores registrados na ordem em que foram adicionados ao objeto de contexto.

Parâmetros:

handler - O manipulador a ser adicionado ao objeto de contexto.

Retornos:

O objeto de contexto atualizado.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Adiciona um manipulador de resposta para operações de atividade de envio.

Quando os métodos sendActivity(Activity activity) ou sendActivities(List<Activity> activities) do contexto são chamados, o adaptador chama os manipuladores registrados na ordem em que foram adicionados ao objeto de contexto.

Parâmetros:

handler - O manipulador a ser adicionado ao objeto de contexto.

Retornos:

O objeto de contexto atualizado.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Adiciona um manipulador de resposta para operações de atividade de atualização.

Quando o updateActivity(Activity withActivity) do contexto é chamado, o adaptador chama os manipuladores registrados na ordem em que foram adicionados ao objeto de contexto.

Parâmetros:

handler - O manipulador a ser adicionado ao objeto de contexto.

Retornos:

O objeto de contexto atualizado.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

Método auxiliar para enviar uma matriz de Atividades. Isso chama sendActivities(List<Activity> activities).

Parâmetros:

activities - A matriz de atividades.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivities

public abstract CompletableFuture sendActivities(List activities)

Envia uma lista de atividades para o remetente da atividade de entrada.

Se as atividades forem enviadas com êxito, o resultado da tarefa conterá uma matriz de objetos ResourceResponse contendo as IDs que o canal de recebimento atribuiu às atividades.

Parâmetros:

activities - As atividades a serem enviadas.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

Envia uma atividade para o remetente da atividade de entrada.

Parâmetros:

activity - A atividade a ser enviada.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se a atividade for enviada com êxito, o resultado da tarefa conterá um objeto ResourceResponse que contém a ID que o canal de recebimento atribuiu à atividade.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

Envia uma atividade de mensagem para o remetente da atividade de entrada.

Se a atividade for enviada com êxito, o resultado da tarefa conterá um objeto ResourceResponse que contém a ID que o canal de recebimento atribuiu à atividade.

Consulte a documentação do canal para obter limites impostos sobre o conteúdo de textReplyToSend.

Parâmetros:

textReplyToSend - O texto da mensagem a ser enviada.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

Envia uma atividade de mensagem para o remetente da atividade de entrada.

Se a atividade for enviada com êxito, o resultado da tarefa conterá um objeto ResourceResponse que contém a ID que o canal de recebimento atribuiu à atividade.

Consulte a documentação do canal para obter limites impostos sobre o conteúdo de textReplyToSend.

Para controlar várias características da fala do bot, como voz, taxa, volume, pronúncia e tom, especifique speak no formato SSML (Speech Synthesis Markup Language).

Parâmetros:

textReplyToSend - O texto da mensagem a ser enviada.

speak - Opcional, o texto a ser falado pelo bot em um canal habilitado para fala.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivity

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

Envia uma atividade de mensagem para o remetente da atividade de entrada.

Se a atividade for enviada com êxito, o resultado da tarefa conterá um objeto ResourceResponse que contém a ID que o canal de recebimento atribuiu à atividade.

Consulte a documentação do canal para obter limites impostos sobre o conteúdo de textReplyToSend.

Para controlar várias características da fala do bot, como voz, taxa, volume, pronúncia e tom, especifique speak no formato SSML (Speech Synthesis Markup Language).

Parâmetros:

textReplyToSend - O texto da mensagem a ser enviada.

speak - Opcional, o texto a ser falado pelo bot em um canal habilitado para fala.

inputHint - Opcional, indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. Um deles: "acceptingInput", "ignoringInput" ou "expectingInput". O padrão é "acceptingInput".

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

Envia uma atividade para o remetente da Atividade de entrada sem retornar um ResourceResponse.

Parâmetros:

activity - A atividade a ser enviada.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

setLocale

public abstract void setLocale(String withLocale)

Defina a localidade neste objeto de contexto.

Parâmetros:

withLocale - A cadeia de caracteres de localidade neste objeto de contexto.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Parâmetros:

turnContext - O turnContext.

name - O nome da atividade.

Retornos:

Um futuro com o ResourceReponse.

traceActivity

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

Envia uma atividade de rastreamento para o BotAdapter para fins de registro em log.

Parâmetros:

turnContext - O contexto da curva atual.

name - O valor a ser atribuído à propriedade Activity#getName da atividade.

value - O valor a ser atribuído à propriedade Activity#getValue da atividade.

valueType - O valor a ser atribuído à propriedade Activity#getValueType da atividade.

label - O valor a ser atribuído à propriedade Activity#getLabel da atividade.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se o adaptador estiver sendo hospedado no Emulador, o resultado da tarefa conterá um objeto ResourceResponse com a ID da atividade de rastreamento original; caso contrário, ele contém um objeto ResourceResponse que contém a ID que o canal de recebimento atribuiu à atividade.

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

Substitui uma atividade existente.

Se a atividade for enviada com êxito, o resultado da tarefa conterá um objeto ResourceResponse que contém a ID que o canal de recebimento atribuiu à atividade.

Antes de chamar isso, defina a ID da atividade de substituição como a ID da atividade a ser substituída.

Parâmetros:

withActivity - Nova atividade de substituição.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.