UserToken Interface

Package:
com.microsoft.bot.connector
Maven Artifact:
com.microsoft.bot:bot-connector:4.14.3

public interface UserToken

An instance of this class provides access to all the operations defined in UserTokens.

Method Summary

Modifier and Type Method and Description
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)

Send a dummy OAuth card when the bot is being used on the Emulator for testing without fetching a real token.
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)

Method Details

exchangeToken

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

Parameters:

userId - the String value
connectionName - the String value
channelId - the String value
exchangeRequest - a TokenExchangeRequest

Returns:

the observable to the TokenResponse object

getAadTokens

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

Parameters:

userId - the String value
connectionName - the String value
aadResourceUrls - the AadResourceUrls value

Returns:

the observable to the Map<String, TokenResponse> object

getAadTokens

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

Parameters:

userId - the String value
connectionName - the String value
aadResourceUrls - the AadResourceUrls value
channelId - the String value

Returns:

the observable to the Map<String, TokenResponse> object

getToken

public abstract CompletableFuture getToken(String userId, String connectionName)

Parameters:

userId - the String value
connectionName - the String value

Returns:

the observable to the TokenResponse object

getToken

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

Parameters:

userId - the String value
connectionName - the String value
channelId - the String value
code - the String value

Returns:

the observable to the TokenResponse object

getTokenStatus

public abstract CompletableFuture> getTokenStatus(String userId)

Parameters:

userId - the String value

Returns:

the observable to the List<TokenStatus> object

getTokenStatus

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

Parameters:

userId - the String value
channelId - the String value
include - the String value

Returns:

the observable to the List<TokenStatus> object

sendEmulateOAuthCards

public abstract CompletableFuture sendEmulateOAuthCards(boolean emulateOAuthCards)

Send a dummy OAuth card when the bot is being used on the Emulator for testing without fetching a real token.

Parameters:

emulateOAuthCards - Indicates whether the Emulator should emulate the OAuth card.

Returns:

A task that represents the work queued to execute.

signOut

public abstract CompletableFuture signOut(String userId)

Parameters:

userId - the String value

Returns:

the observable to the Object object

signOut

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

Parameters:

userId - the String value
connectionName - the String value
channelId - the String value

Returns:

the observable to the Object object

Applies to