BotFrameworkAdapter Classe

public static final String CONNECTOR_CLIENT_KEY

Chiave per archiviare ConnectorClient.

public static final String INVOKE_RESPONSE_KEY

Chiave per archiviare InvokeResponse.

public static final String TEAMSCONNECTOR_CLIENT_KEY

Chiave per archiviare TeamsConnectorClient. Solo per i test.

public BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Inizializza una nuova istanza della classe BotFrameworkAdapter utilizzando un provider di credenziali.

Parametri:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

Inizializza una nuova istanza della classe BotFrameworkAdapter utilizzando un provider di credenziali.

Parametri:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Inizializza una nuova istanza della classe BotFrameworkAdapter utilizzando un provider di credenziali.

Parametri:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Inizializza una nuova istanza della classe BotFrameworkAdapter utilizzando un provider di credenziali.

Parametri:

protected void addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client)

Inserisce un ConnectorClient nella cache. SOLO PER UNIT TEST.

Parametri:

protected CompletableFuture buildAppCredentials(String appId, String scope)

Crea un oggetto AppCredentials per l'appId e l'ambito specificati.

Parametri:

Restituisce:

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

Invia un messaggio proattivo a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Override:

Parametri:

Restituisce:

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

Invia un messaggio proattivo a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Override:

Parametri:

Restituisce:

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

Invia un messaggio proattivo dal bot a una conversazione.

Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

Questo overload differisce dall'implementazione di Node richiedendo il passaggio di BotId. Il codice .NET consente di ospitare più bot in un'unica scheda che non è un elemento supportato da Node.

processActivity(String authHeader, Activity activity, BotCallbackHandler callback) runPipeline(TurnContext context, BotCallbackHandler callback)

Override:

Parametri:

Restituisce:

public CompletableFuture createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience)

Crea il client del connettore asincrono.

Parametri:

Restituisce:

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback)

Crea una conversazione sul canale specificato. Per avviare una conversazione, il bot deve conoscere le informazioni sull'account e le informazioni sull'account dell'utente su tale canale. La maggior parte dei canali supporta solo l'avvio di una conversazione diretta (non di gruppo).

L'adapter tenta di creare una nuova conversazione sul canale e quindi invia un'attività conversationUpdate tramite la pipeline middleware al metodo callback.

Se la conversazione viene stabilita con gli utenti specificati, l'ID del Activity#getConversation dell'attività conterrà l'ID della nuova conversazione.

Parametri:

Restituisce:

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference)

Crea una conversazione sul canale specificato. Per avviare una conversazione, il bot deve conoscere le informazioni sull'account e le informazioni sull'account dell'utente su tale canale. La maggior parte dei canali supporta solo l'avvio di una conversazione diretta (non di gruppo).

L'adapter tenta di creare una nuova conversazione sul canale e quindi invia un'attività conversationUpdate tramite la pipeline middleware al metodo callback.

Se la conversazione viene stabilita con gli utenti specificati, l'ID del Activity#getConversation dell'attività conterrà l'ID della nuova conversazione.

Parametri:

Restituisce:

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

Crea un client OAuth per il bot.

Nota: questa opzione è protetta principalmente in modo che gli unit test possano eseguire l'override per fornire un OAuthClient fittizio.

Parametri:

Restituisce:

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Elimina un'attività esistente nella conversazione.

Override:

Parametri:

Restituisce:

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

Elimina un membro dalla conversazione corrente.

Parametri:

Restituisce:

public CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.

Parametri:

Restituisce:

public CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.

Parametri:

Restituisce:

public CompletableFuture> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata usando appCredentials personalizzate.

Parametri:

Restituisce:

public CompletableFuture> getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId)

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata.

Parametri:

Restituisce:

public CompletableFuture> getActivityMembers(TurnContextImpl context)

Elenca i membri di una determinata attività.

Parametri:

Restituisce:

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

Elenca i membri di una determinata attività.

Parametri:

Restituisce:

protected Map getConnectorClientCache()

Ottenere la cache ConnectorClient. PER UNIT TEST.

Restituisce:

public CompletableFuture> getConversationMembers(TurnContextImpl context)

Elenca i membri della conversazione corrente.

Parametri:

Restituisce:

public CompletableFuture getConversations(TurnContextImpl context)

Elenca le conversazioni in cui questo bot ha partecipato per un determinato server di canale. Il server di canale restituisce i risultati nelle pagine e ogni pagina includerà un 'continuationToken' che può essere usato per recuperare la pagina successiva dei risultati dal server. Questo overload può essere chiamato durante l'elaborazione dell'attività standard, a questo punto verranno usate l'URL del servizio del bot e le credenziali che fanno parte della pipeline di elaborazione dell'attività corrente.

Parametri:

Restituisce:

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

Elenca le conversazioni in cui questo bot ha partecipato per un determinato server di canale. Il server di canale restituisce i risultati nelle pagine e ogni pagina includerà un 'continuationToken' che può essere usato per recuperare la pagina successiva dei risultati dal server. Questo overload può essere chiamato durante l'elaborazione dell'attività standard, a questo punto verranno usate l'URL del servizio del bot e le credenziali che fanno parte della pipeline di elaborazione dell'attività corrente.

Parametri:

Restituisce:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

Elenca le conversazioni in cui questo bot ha partecipato per un determinato server di canale. Il server di canale restituisce i risultati nelle pagine e ogni pagina includerà un 'continuationToken' che può essere usato per recuperare la pagina successiva dei risultati dal server.

Parametri:

Restituisce:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken)

Elenca le conversazioni in cui questo bot ha partecipato per un determinato server di canale. Il server di canale restituisce i risultati nelle pagine e ogni pagina includerà un 'continuationToken' che può essere usato per recuperare la pagina successiva dei risultati dal server. Questo overload può essere chiamato dall'esterno del contesto di una conversazione, perché sono necessarie solo le credenziali e ServiceUrl del bot.

Parametri:

Restituisce:

protected Map getCredentialsCache()

Ottenere la cache AppCredentials. Per gli unit test.

Restituisce:

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione usando AppCredentials personalizzato.

Parametri:

Restituisce:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione, usando le credenziali app del bot.

Parametri:

Restituisce:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

Restituisce:

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

Restituisce:

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

Restituisce un connettoreClient, da una cache o da una nuova creazione.

Nota: questa opzione è protetta principalmente per consentire agli unit test di eseguire l'override di questa impostazione per fornire un connettore fittizioClient

Parametri:

Restituisce:

public CompletableFuture getSignInResource(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

Restituisce:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

Restituisce:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Ottenere il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

Parametri:

Restituisce:

     If the task completes successfully, the result contains the raw
     signin link.

public CompletableFuture> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando AppCredentials personalizzato.

Parametri:

Restituisce:

public CompletableFuture> getTokenStatus(TurnContext context, String userId, String includeFilter)

Recupera lo stato del token per ogni connessione configurata per l'utente specificato.

Parametri:

Restituisce:

public CompletableFuture getUserToken(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

Tenta di recuperare il token per un utente che si trova in un flusso di accesso usando AppCredentials personalizzato.

Parametri:

Restituisce:

public CompletableFuture getUserToken(TurnContext context, String connectionName, String magicCode)

Tenta di recuperare il token per un utente che si trova in un flusso di accesso.

Parametri:

Restituisce:

protected static String keyForAppCredentials(String appId, String scope)

Genera la chiave per l'accesso alla cache delle credenziali dell'app.

Parametri:

Restituisce:

protected static String keyForConnectorClient(String serviceUrl, String appId, String scope)

Genera la chiave per l'accesso alla cache client del connettore.

Parametri:

Restituisce:

public CompletableFuture processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback)

Crea un contesto di turno ed esegue la pipeline middleware per un'attività in ingresso.

Parametri:

Restituisce:

public CompletableFuture processActivity(String authHeader, Activity activity, BotCallbackHandler callback)

Crea un contesto di turno ed esegue la pipeline middleware per un'attività in ingresso.

Parametri:

Restituisce:

public CompletableFuture sendActivities(TurnContext context, List activities)

Invia attività alla conversazione.

Override:

Parametri:

Restituisce:

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

public CompletableFuture signOutUser(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Disconnette l'utente con il server token usando AppCredentials personalizzato.

Parametri:

Restituisce:

public CompletableFuture signOutUser(TurnContext context, String connectionName, String userId)

Disconnette l'utente con il server token.

Parametri:

Restituisce:

public CompletableFuture updateActivity(TurnContext context, Activity activity)

Sostituisce un'attività esistente nella conversazione.

Override:

Parametri:

Restituisce:

public BotFrameworkAdapter use(Middleware middleware)

Aggiunge middleware alla pipeline dell'adapter. Il middleware viene aggiunto all'adapter in fase di inizializzazione. Per ogni turno, l'adattatore chiama middleware nell'ordine in cui è stato aggiunto.

Override:

Parametri:

Restituisce: