UserTokenProvider 介面

  • 參考
套件:
com.microsoft.bot.builder
Maven 成品:
com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

OAuth 提供者。

方法摘要

修飾詞與類型 方法與描述
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

執行令牌交換作業，例如單一登錄。
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

執行令牌交換作業，例如單一登錄。
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

使用自定義的應用程式認證，擷取已設定連線上特定資源的 Azure Active Directory 令牌。
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

擷取已設定連線上特定資源的 Azure Active Directory 令牌。
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

擷取已設定連線上特定資源的 Azure Active Directory 令牌。
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

使用自定義的應用程式認證，取得要傳送給使用者以進行連線名稱登入的原始登入連結。
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

使用自定義的應用程式認證，取得要傳送給使用者以進行連線名稱登入的原始登入連結。
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

使用自定義的應用程式認證，擷取指定使用者每個已設定連線的令牌狀態。
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId)

擷取指定使用者每個已設定連線的令牌狀態。
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

擷取指定使用者每個已設定連線的令牌狀態。
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

嘗試使用自定義的應用程式認證，擷取登入流程中使用者的令牌。
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, String connectionName, String magicCode)

嘗試擷取登入流程中之使用者的令牌。
default java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

使用令牌伺服器將用戶註銷。
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

使用自定義的應用程式認證，以令牌伺服器將用戶註銷。
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, String connectionName, String userId)

使用令牌伺服器將用戶註銷。

方法詳細資料

exchangeToken

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

執行令牌交換作業，例如單一登錄。

參數:

turnContext - 目前與使用者交談回合的內容。
oAuthAppCredentials - 適用於 OAuth 的 AppCredentials。
connectionName - 要使用的驗證連線名稱。
userId - 與 token 相關聯的使用者標識碼。
exchangeRequest - 交換要求詳細數據，可以是要交換的令牌或要交換的 URI。

傳回:

如果 CompleteableFuture 完成，則會傳回交換的令牌。

exchangeToken

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

執行令牌交換作業，例如單一登錄。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 要使用的驗證連線名稱。
userId - 與 token 相關聯的使用者標識碼。
exchangeRequest - 交換要求詳細數據，可以是要交換的令牌或要交換的 URI。

傳回:

如果 CompleteableFuture 完成，則會傳回交換的令牌。

getAadTokens

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

使用自定義的 AppCredentials，擷取已設定連線上特定資源的 Azure Active Directory 令牌。

參數:

context - 目前與使用者交談回合的內容。
oAuthAppCredentials - 適用於 OAuth 的 AppCredentials。
connectionName - 使用此 Bot 設定的 Azure Active Directory 連線名稱。
resourceUrls - 要為其擷取令牌的資源URL清單。
userId - 擷取令牌的使用者標識碼。 如果傳入 null，則會從 TurnContext 中的 Activity 取得 userId。

傳回:

resourceUrl 字典至對應的 TokenResponse。

getAadTokens

public default CompletableFuture> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

擷取已設定連線上特定資源的 Azure Active Directory 令牌。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 使用此 Bot 設定的 Azure Active Directory 連線名稱。
resourceUrls - 要為其擷取令牌的資源URL清單。

傳回:

resourceUrl 字典至對應的 TokenResponse。

getAadTokens

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

擷取已設定連線上特定資源的 Azure Active Directory 令牌。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 使用此 Bot 設定的 Azure Active Directory 連線名稱。
resourceUrls - 要為其擷取令牌的資源URL清單。
userId - 擷取令牌的使用者標識碼。 如果傳入 null，則 userId 會取自 ITurnContext 中的 Activity。

傳回:

resourceUrl 字典至對應的 TokenResponse。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

使用自定義的 AppCredentials，取得要傳送給使用者以登入連線名稱的原始登入連結。

參數:

turnContext - 目前與使用者交談回合的內容。
oAuthAppCredentials - 適用於 OAuth 的 AppCredentials。
connectionName - 要使用的驗證連線名稱。

傳回:

CompletableFuture，表示要執行的工作佇列。 如果 CompleteableFuture 成功完成，結果會包含原始登入連結。

getOAuthSignInLink

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

使用自定義的 AppCredentials，取得要傳送給使用者以登入連線名稱的原始登入連結。

參數:

turnContext - 目前與使用者交談回合的內容。
oAuthAppCredentials - 適用於 OAuth 的 AppCredentials。
connectionName - 要使用的驗證連線名稱。
userId - 將與令牌相關聯的使用者標識碼。
finalRedirect - OAuth 流程將重新導向至的最後URL。

傳回:

CompletableFuture，表示要執行的工作佇列。 如果 CompleteableFuture 成功完成，結果會包含原始登入連結。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 要使用的驗證連線名稱。

傳回:

工作，表示要執行的工作佇列。 如果工作順利完成，結果會包含原始登入連結。

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 要使用的驗證連線名稱。
userId - 將與令牌相關聯的使用者標識碼。
finalRedirect - OAuth 流程將重新導向至的最後URL。

傳回:

工作，表示要執行的工作佇列。 如果工作順利完成，結果會包含原始登入連結。

getSignInResource

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

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。

參數:

turnContext - 目前與使用者交談回合的內容。
oAuthAppCredentials - OAuth 認證。
connectionName - 要使用的驗證連線名稱。
userId - 將與令牌相關聯的使用者標識碼。
finalRedirect - OAuth 流程將重新導向至的最後URL。

傳回:

CompletableFuture，表示要執行的工作佇列。 如果 CompleteableFuture 成功完成，結果會包含原始登入連結。

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 要使用的驗證連線名稱。

傳回:

CompletableFuture，表示要執行的工作佇列。 如果 CompleteableFuture 成功完成，結果會包含原始登入連結。

getSignInResource

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

取得要傳送給使用者以登入以取得連線名稱的原始登入連結。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 要使用的驗證連線名稱。
userId - 將與令牌相關聯的使用者標識碼。
finalRedirect - OAuth 流程將重新導向至的最後URL。

傳回:

CompletableFuture，表示要執行的工作佇列。 如果 CompleteableFuture 成功完成，結果會包含原始登入連結。

getTokenStatus

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

使用自定義的AppCredentials，擷取指定使用者每個已設定連線的令牌狀態。

參數:

context - 目前與使用者交談回合的內容。
oAuthAppCredentials - 適用於 OAuth 的 AppCredentials。
userId - 擷取令牌狀態的使用者標識碼。
includeFilter - 要包含之連接的選擇性逗號分隔清單。 空白會傳回所有已設定連線的令牌狀態。

傳回:

TokenStatus 的陣列。

getTokenStatus

public default CompletableFuture> getTokenStatus(TurnContext turnContext, String userId)

擷取指定使用者每個已設定連線的令牌狀態。

參數:

turnContext - 目前與使用者交談回合的內容。
userId - 擷取令牌狀態的使用者標識碼。

傳回:

TokenStatus 的陣列。

getTokenStatus

public abstract CompletableFuture> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

擷取指定使用者每個已設定連線的令牌狀態。

參數:

turnContext - 目前與使用者交談回合的內容。
userId - 擷取令牌狀態的使用者標識碼。
includeFilter - 要包含的連接逗號分隔清單。 空白會傳回所有已設定連線的令牌狀態。

傳回:

TokenStatus 的陣列。

getUserToken

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

嘗試使用自定義的AppCredentials擷取登入流程中使用者的令牌。

參數:

turnContext - 目前與使用者交談回合的內容。
oAuthAppCredentials - 適用於 OAuth 的 AppCredentials。
connectionName - 要使用的驗證連線名稱。
magicCode - （選擇性）選擇性使用者輸入要驗證的程序代碼。

傳回:

令牌回應。

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, String connectionName, String magicCode)

嘗試擷取登入流程中之使用者的令牌。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 要使用的驗證連線名稱。
magicCode - （選擇性）選擇性使用者輸入要驗證的程序代碼。

傳回:

令牌回應。

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

使用令牌伺服器將用戶註銷。

參數:

turnContext - 目前與使用者交談回合的內容。

傳回:

工作，表示要執行的工作佇列。

signOutUser

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

使用自定義的 AppCredentials，以令牌伺服器將用戶登出。

參數:

turnContext - 目前與使用者交談回合的內容。
oAuthAppCredentials - 適用於 OAuth 的 AppCredentials。
connectionName - 要使用的驗證連線名稱。
userId - 要註銷的使用者標識碼。

傳回:

CompletableFuture，表示要執行的工作佇列。

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, String connectionName, String userId)

使用令牌伺服器將用戶註銷。

參數:

turnContext - 目前與使用者交談回合的內容。
connectionName - 要使用的驗證連線名稱。
userId - 要註銷的使用者標識碼。

傳回:

工作，表示要執行的工作佇列。

適用於