TurnContextImpl Classe

Pacote:

com.microsoft.bot.builder

Artefato Maven:

com.microsoft.bot:bot-builder:4.14.3

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

Implementações

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

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 para o comprimento da curva. Bot Middleware

Resumo do Construtor

Construtor	Description
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)	Cria um objeto de contexto.

Resumo do método

Modificador e tipo	Método e descrição
void	close() AutoClosable#close.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(ConversationReference conversationReference) Exclui uma atividade existente.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(String activityId) Exclui uma atividade existente.
void	finalize() Chamada automática de #close.
Activity	getActivity() Obtém a atividade associada a este turno; ou null ao processar uma mensagem proativa.
BotAdapter	getAdapter() Obtém o adaptador de bot que criou esse objeto de contexto.
java.util.List<Activity>	getBufferedReplyActivities() Obtém uma lista de atividades a serem enviadas quando 'context. Atividade. Modo de Entrega== 'esperarRespostas'.
java.lang.String	getLocale() Obtém a localidade neste objeto de contexto.
boolean	getResponded() Indica se pelo menos uma resposta foi enviada para o turno atual.
TurnContextStateCollection	getTurnState() Obtém os serviços registrados neste objeto de contexto.
TurnContext	onDeleteActivity(DeleteActivityHandler handler) Adiciona um manipulador de resposta para operações de atividade de exclusão.
TurnContext	onSendActivities(SendActivitiesHandler handler) Adiciona um manipulador de resposta para operações de atividade de envio.
TurnContext	onUpdateActivity(UpdateActivityHandler handler) Adiciona um manipulador de resposta para operações de atividade de atualização.
java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) Envia um conjunto de atividades para o remetente da atividade de entrada.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activityToSend) Envia uma atividade para o remetente da atividade de entrada.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) Envia uma atividade de mensagem para o remetente da atividade de entrada.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) Envia uma atividade de mensagem para o remetente da atividade de entrada.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak, InputHints inputHint) Envia uma atividade de mensagem para o remetente da atividade de entrada.
void	setLocale(String withLocale) Defina a localidade neste objeto de contexto.
java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) Substitui uma atividade existente.

Métodos herdados de 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

Detalhes do construtor

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Cria um objeto de contexto.

Parameters:

withAdapter - O adaptador que cria o contexto.

withActivity - A atividade de entrada para o turno; ou null para uma vez para uma mensagem proativa.

Detalhes do método

close

public void close()

AutoClosable#close.

Throws:

java.lang.Exception - Se o TurnContextStateCollection.

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

Exclui uma atividade existente. A referência de ConversationReference#getActivityId conversa indica a atividade na conversa a ser excluída.

Parameters:

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

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

deleteActivity

public CompletableFuture deleteActivity(String activityId)

Exclui uma atividade existente.

Parameters:

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

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

finalize

public void finalize()

Chamada automática de #close.

Overrides:

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

Obtém a atividade associada a este turno; ou null ao processar uma mensagem proativa.

getAdapter

public BotAdapter getAdapter()

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

Returns:

O BotAdaptor para este turno.

getBufferedReplyActivities

public List getBufferedReplyActivities()

Obtém uma lista de atividades a serem enviadas quando 'context. Activity.DeliveryMode == 'expectReplies'.

Returns:

Uma lista de atividades.

getLocale

public String getLocale()

Obtém a localidade neste objeto de contexto.

Returns:

A cadeia de caracteres de localidade neste objeto de contexto.

getResponded

public boolean getResponded()

Indica se pelo menos uma resposta foi enviada para o turno atual.

Returns:

true se pelo menos uma resposta foi enviada para o turno atual.

getTurnState

public TurnContextStateCollection getTurnState()

Obtém os serviços registrados neste objeto de contexto.

Returns:

o TurnContextStateCollection para este turno.

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

Parameters:

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

Returns:

O objeto de contexto atualizado.

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

Parameters:

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

Returns:

O objeto de contexto atualizado.

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

Parameters:

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

Returns:

O objeto de contexto atualizado.

sendActivities

public CompletableFuture sendActivities(List activities)

Envia um conjunto de atividades para o remetente da atividade de entrada.

Parameters:

activities - As atividades a serem enviadas.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se as atividades forem enviadas com êxito, o resultado da tarefa conterá uma matriz de ResourceResponse objetos que contêm as IDs atribuídas pelo canal de recebimento às atividades.

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

Envia uma atividade para o remetente da atividade de entrada.

Parameters:

activityToSend - A atividade a ser enviada.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivity

public 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 ResourceResponse objeto que contém a ID que o canal de recebimento atribuiu à atividade.

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

Parameters:

textReplyToSend - O texto da mensagem a ser enviada.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivity

public 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 ResourceResponse objeto que contém a ID que o canal de recebimento atribuiu à atividade.

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

Parameters:

textReplyToSend - O texto da mensagem a ser enviada.

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

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

sendActivity

public 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 ResourceResponse objeto que contém a ID que o canal de recebimento atribuiu à atividade.

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

Parameters:

textReplyToSend - O texto da mensagem a ser enviada.

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

inputHint - (Opcional) Dica de entrada.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

setLocale

public void setLocale(String withLocale)

Defina a localidade neste objeto de contexto.

Parameters:

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

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

Substitui uma atividade existente.

Parameters:

withActivity - Nova atividade de substituição.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.