BotFrameworkHttpClient Classe

  • Referência
Pacote:
com.microsoft.bot.integration
Artefato Maven:
com.microsoft.bot:bot-integration-core:4.14.3

public class BotFrameworkHttpClient
extends BotFrameworkClient

Classe para postar atividades com segurança em um bot usando o protocolo HTTP do BotFramework. Essa classe pode ser usada para postar atividades com segurança em um bot usando o protocolo HTTP do Bot Framework. Há dois padrões de uso:* Atividade de encaminhamento para uma habilidade (Bot –> Bot como uma habilidade) que é feita por meio de PostActivity(fromBotId, toBotId, ponto de extremidade, serviceUrl, atividade);* Postando uma atividade para si mesmo (serviço externo –> Bot) que é feita por meio de PostActivity(botId, ponto de extremidade, atividade)Este último é usado por serviços externos, como webjobs que precisam postar atividades no bot usando as próprias credenciais dos bots.

Resumo do Construtor

Construtor Description
BotFrameworkHttpClient(CredentialProvider credentialProvider, ChannelProvider channelProvider)

Inicializa uma nova instância da classe BotFrameworkHttpClient.

Resumo do método

Modificador e tipo Método e descrição
java.util.concurrent.CompletableFuture<TypedInvokeResponse<T>> <T>postActivity(String fromBotId, String toBotId, URI toUrl, URI serviceUrl, String conversationId, Activity activity, Class<T> type)

Encaminha uma atividade para uma habilidade (bot).
java.util.concurrent.CompletableFuture<TypedInvokeResponse<T>> <T>postActivity(String botId, URI botEndpoint, Activity activity, Class<T> type)

Postar Atividade no bot usando as credenciais do bot.
protected java.util.concurrent.CompletableFuture<AppCredentials> buildCredentials(String appId, String oAuthScope)

Lógica para criar um objeto AppCredentials a ser usado para adquirir tokens para esse getHttpClient().
protected static java.util.Map<java.lang.String,AppCredentials> getAppCredentialMapCache()

Obtém o Cache do aplicativoCredenciais para acelerar a aquisição de token (um token não é solicitado, a menos que esteja expirado).
protected ChannelProvider getChannelProvider()

Obtém o provedor de canal para este adaptador.
protected CredentialProvider getCredentialProvider()

Obtém o provedor de credenciais para este adaptador.
okhttp3.OkHttpClient getHttpClient()

Obtém o Cliente httppara este adaptador.

Métodos herdados de BotFrameworkClient

<T>postActivity

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

BotFrameworkHttpClient

public BotFrameworkHttpClient(CredentialProvider credentialProvider, ChannelProvider channelProvider)

Inicializa uma nova instância da classe BotFrameworkHttpClient.

Parâmetros:

credentialProvider - Uma instância de CredentialProvider .
channelProvider - Uma instância de ChannelProvider .

Detalhes do método

<T>postActivity

public CompletableFuture> postActivity(String fromBotId, String toBotId, URI toUrl, URI serviceUrl, String conversationId, Activity activity, Class type)

Encaminha uma atividade para uma habilidade (bot). OBSERVAÇÃO: o encaminhamento de uma atividade para uma habilidade liberará as alterações de UserState e ConversationState para que a habilidade tenha um estado preciso.

Substituições:

BotFrameworkHttpClient.<T>postActivity(String fromBotId, String toBotId, URI toUrl, URI serviceUrl, String conversationId, Activity activity, Class<T> type)

Parâmetros:

fromBotId - O MicrosoftAppId do bot que envia a atividade.
toBotId - O MicrosoftAppId do bot que está recebendo a atividade.
toUrl - A URL do bot que está recebendo a atividade.
serviceUrl - A URL de retorno de chamada para o host de habilidade.
conversationId - Uma conversa D a ser usada para a conversa com a habilidade.
activity - atividade a ser encaminhada.
type

Retornos:

tarefa com invokeResponse opcional.

<T>postActivity

public CompletableFuture> postActivity(String botId, URI botEndpoint, Activity activity, Class type)

Postar Atividade no bot usando as credenciais do bot.

Parâmetros:

botId - O MicrosoftAppId do bot.
botEndpoint - A URL do bot.
activity - Atividade a ser postada.
type - Tipo de .

Retornos:

InvokeResponse.

buildCredentials

protected CompletableFuture buildCredentials(String appId, String oAuthScope)

Lógica para criar um objeto AppCredentials a ser usado para adquirir tokens para este getHttpClient().

Parâmetros:

appId - A ID do aplicativo.
oAuthScope - O escopo opcional do OAuth.

Retornos:

As credenciais do aplicativo a serem usadas para adquirir tokens.

getAppCredentialMapCache

protected static Map getAppCredentialMapCache()

Obtém o Cache para appCredentials para acelerar a aquisição de token (um token não é solicitado, a menos que esteja expirado). AppCredentials são armazenados em cache usando appId + escopo (este último parâmetro só é usado se as credenciais do aplicativo são usadas para chamar uma habilidade).

Retornos:

o valor AppCredentialMapCache como uma cadeia de<ConcurrentDictionary estática, AppCredentials>.

getChannelProvider

protected ChannelProvider getChannelProvider()

Obtém o provedor de canal para este adaptador.

Retornos:

o valor ChannelProvider como um getChannelProvider().

getCredentialProvider

protected CredentialProvider getCredentialProvider()

Obtém o provedor de credenciais para este adaptador.

Retornos:

o valor credentialProvider como um getCredentialProvider().

getHttpClient

public OkHttpClient getHttpClient()

Obtém o HttpClient para este adaptador.

Retornos:

o valor de OkhttpClient como um getHttpClient().

Aplica-se a