UserToken インターフェイス

  • リファレンス
パッケージ:
com.microsoft.bot.connector
Maven 成果物:
com.microsoft.bot:bot-connector:4.14.3

public interface UserToken

このクラスのインスタンスは、UserTokens で定義されているすべての操作へのアクセスを提供します。

メソッドの概要

修飾子と型 メソッドと説明
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(String userId, String connectionName, String channelId, TokenExchangeRequest exchangeRequest)
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(String userId, String connectionName, AadResourceUrls aadResourceUrls)
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(String userId, String connectionName, AadResourceUrls aadResourceUrls, String channelId)
abstract java.util.concurrent.CompletableFuture<TokenResponse> getToken(String userId, String connectionName)
abstract java.util.concurrent.CompletableFuture<TokenResponse> getToken(String userId, String connectionName, String channelId, String code)
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(String userId)
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(String userId, String channelId, String include)
abstract java.util.concurrent.CompletableFuture<java.lang.Void> sendEmulateOAuthCards(boolean emulateOAuthCards)

実際のトークンをフェッチせずにテストのためにボットがエミュレーターで使用されている場合は、ダミーの OAuth カードを送信します。
abstract java.util.concurrent.CompletableFuture<java.lang.Object> signOut(String userId)
abstract java.util.concurrent.CompletableFuture<java.lang.Object> signOut(String userId, String connectionName, String channelId)

メソッドの詳細

exchangeToken

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

パラメーター:

userId - 文字列値
connectionName - 文字列値
channelId - 文字列値
exchangeRequest - TokenExchangeRequest

戻り値:

TokenResponse オブジェクトに対する監視可能なオブジェクト

getAadTokens

public abstract CompletableFuture> getAadTokens(String userId, String connectionName, AadResourceUrls aadResourceUrls)

パラメーター:

userId - 文字列値
connectionName - 文字列値
aadResourceUrls - AadResourceUrls 値

戻り値:

Map<String、TokenResponse> オブジェクトに対して監視可能

getAadTokens

public abstract CompletableFuture> getAadTokens(String userId, String connectionName, AadResourceUrls aadResourceUrls, String channelId)

パラメーター:

userId - 文字列値
connectionName - 文字列値
aadResourceUrls - AadResourceUrls 値
channelId - 文字列値

戻り値:

Map<String、TokenResponse> オブジェクトに対して監視可能

getToken

public abstract CompletableFuture getToken(String userId, String connectionName)

パラメーター:

userId - 文字列値
connectionName - 文字列値

戻り値:

TokenResponse オブジェクトに対する監視可能なオブジェクト

getToken

public abstract CompletableFuture getToken(String userId, String connectionName, String channelId, String code)

パラメーター:

userId - 文字列値
connectionName - 文字列値
channelId - 文字列値
code - 文字列値

戻り値:

TokenResponse オブジェクトに対する監視可能なオブジェクト

getTokenStatus

public abstract CompletableFuture> getTokenStatus(String userId)

パラメーター:

userId - 文字列値

戻り値:

List<TokenStatus> オブジェクトに対する監視可能なオブジェクト

getTokenStatus

public abstract CompletableFuture> getTokenStatus(String userId, String channelId, String include)

パラメーター:

userId - 文字列値
channelId - 文字列値
include - 文字列値

戻り値:

List<TokenStatus> オブジェクトに対する監視可能なオブジェクト

sendEmulateOAuthCards

public abstract CompletableFuture sendEmulateOAuthCards(boolean emulateOAuthCards)

実際のトークンをフェッチせずにテストのためにボットがエミュレーターで使用されている場合は、ダミーの OAuth カードを送信します。

パラメーター:

emulateOAuthCards - エミュレーターが OAuth カードをエミュレートする必要があるかどうかを示します。

戻り値:

実行するキューに登録された作業を表すタスク。

signOut

public abstract CompletableFuture signOut(String userId)

パラメーター:

userId - 文字列値

戻り値:

Object オブジェクトに対する監視可能なオブジェクト

signOut

public abstract CompletableFuture signOut(String userId, String connectionName, String channelId)

パラメーター:

userId - 文字列値
connectionName - 文字列値
channelId - 文字列値

戻り値:

Object オブジェクトに対する監視可能なオブジェクト

適用対象