sdk/com.oursky.authgear/Authgear

Authgear

class Authgear @JvmOverloads constructor(application: Application, clientId: String, authgearEndpoint: String, tokenStorage: TokenStorage = PersistentTokenStorage(application), uiImplementation: UIImplementation = CustomTabsUIImplementation(), isSsoEnabled: Boolean = false, preAuthenticatedURLEnabled: Boolean = false, name: String? = null, app2AppOptions: App2AppOptions = App2AppOptions(isEnabled = false))

Constructors

constructor(application: Application, clientId: String, authgearEndpoint: String, tokenStorage: TokenStorage = PersistentTokenStorage(application), uiImplementation: UIImplementation = CustomTabsUIImplementation(), isSsoEnabled: Boolean = false, preAuthenticatedURLEnabled: Boolean = false, name: String? = null, app2AppOptions: App2AppOptions = App2AppOptions(isEnabled = false))

Types

object Companion

Properties

@get:MainThread

val accessToken: String?

Current access token.

@get:MainThread

val authTime: Date?

canReauthenticate

@get:MainThread

val canReauthenticate: Boolean

@get:MainThread

val clientId: String

OAuth client ID.

@get:MainThread

@set:MainThread

var delegate: AuthgearDelegate?

@get:MainThread

val idTokenHint: String?

@get:MainThread

val sessionState: SessionState

Current session state. See SessionState.

Functions

approveApp2AppAuthenticationRequest

@RequiresApi(api = 23)

fun approveApp2AppAuthenticationRequest(request: App2AppAuthenticateRequest, listener: OnHandleApp2AppAuthenticationRequestListener, handler: Handler = Handler(Looper.getMainLooper()))

Approve a app2app authentication request.

approveApp2AppAuthenticationRequest

@RequiresApi(value = 23)

suspend fun Authgear.approveApp2AppAuthenticationRequest(request: App2AppAuthenticateRequest)

fun authenticate(options: AuthenticateOptions, onAuthenticateListener: OnAuthenticateListener, handler: Handler = Handler(Looper.getMainLooper()))

Authenticate a user by directing the user to an external browser to authenticate.

suspend fun Authgear.authenticate(options: AuthenticateOptions): UserInfo

authenticateAnonymousLy

suspend fun Authgear.authenticateAnonymousLy(): UserInfo

authenticateAnonymously

fun authenticateAnonymously(onAuthenticateAnonymouslyListener: OnAuthenticateAnonymouslyListener, handler: Handler = Handler(Looper.getMainLooper()))

Authenticate anonymously by generating a dummy user. The dummy user persist until the app is uninstalled.

authenticateBiometric

@RequiresApi(api = 23)

fun authenticateBiometric(options: BiometricOptions, onAuthenticateBiometricListener: OnAuthenticateBiometricListener, handler: Handler = Handler(Looper.getMainLooper()))

Authenticate with previously enabled biometric.

authenticateBiometric

@RequiresApi(value = 23)

suspend fun Authgear.authenticateBiometric(options: BiometricOptions): UserInfo

fun changePassword(options: SettingsActionOptions, listener: OnOpenSettingsActionListener? = null, handler: Handler = Handler(Looper.getMainLooper()))

Open change password page in webview

checkBiometricSupported

@RequiresApi(api = 23)

fun checkBiometricSupported(context: Context, allowedAuthenticators: Int)

Check if biometric is supported. If not supported, an exception will be thrown.

clearSessionState

fun clearSessionState()

Clear SDK session state. Clear refresh token and reset session state to SessionState.NO_SESSION.

fun configure(onConfigureListener: OnConfigureListener, handler: Handler = Handler(Looper.getMainLooper()))

Configure authgear. This must be ran before any other methods. If configuration is successful and there was a valid user session, authgear's accessToken is non-null and the token is ready to be used.

suspend fun Authgear.configure()

createAuthenticateRequest

fun createAuthenticateRequest(options: AuthenticateOptions, listener: OnCreateAuthenticationRequestListener, handler: Handler = Handler(Looper.getMainLooper()))

createAuthenticateRequest

suspend fun Authgear.createAuthenticateRequest(options: AuthenticateOptions): AuthenticationRequest

createReauthenticateRequest

suspend fun Authgear.createReauthenticateRequest(options: ReauthenticateOptions): AuthenticationRequest

fun deleteAccount(options: SettingsActionOptions, listener: OnOpenSettingsActionListener? = null, handler: Handler = Handler(Looper.getMainLooper()))

Open delete account page in webview

disableBiometric

fun disableBiometric()

Disable biometric if it was enabled.

enableBiometric

@RequiresApi(api = 23)

fun enableBiometric(options: BiometricOptions, onEnableBiometricListener: OnEnableBiometricListener, handler: Handler = Handler(Looper.getMainLooper()))

Enable biometric for the current user.

enableBiometric

@RequiresApi(value = 23)

suspend fun Authgear.enableBiometric(options: BiometricOptions)

fun fetchUserInfo(onFetchUserInfoListener: OnFetchUserInfoListener, handler: Handler = Handler(Looper.getMainLooper()))

Fetch user info. Note that this method does not refresh access token so user should call configure or refreshAccessTokenIfNeeded when necessary.

suspend fun Authgear.fetchUserInfo(): UserInfo

finishAuthentication

fun finishAuthentication(finishUri: String, request: AuthenticationRequest, listener: OnAuthenticateListener, handler: Handler = Handler(Looper.getMainLooper()))

finishAuthentication

suspend fun Authgear.finishAuthentication(finishUri: String, request: AuthenticationRequest): UserInfo

finishReauthentication

suspend fun Authgear.finishReauthentication(finishUri: String, request: AuthenticationRequest): UserInfo

fun generateUrl(redirectURI: String, listener: OnGenerateURLListener, handler: Handler = Handler(Looper.getMainLooper()))

Generate URL for opening webpage with current session.

suspend fun Authgear.generateUrl(redirectURI: String): Uri

isBiometricEnabled

fun isBiometricEnabled(): Boolean

Check if biometric is enabled.

fun logout(force: Boolean? = null, onLogoutListener: OnLogoutListener, handler: Handler = Handler(Looper.getMainLooper()))

Logout the current session by revoking the refresh token and access token. It works for both normal user and anonymous user. For both cases, you can obtain the session again via authenticate or authenticateAnonymously.

suspend fun Authgear.logout(force: Boolean? = null)

makePreAuthenticatedURL

fun makePreAuthenticatedURL(options: PreAuthenticatedURLOptions, listener: OnMakePreAuthenticatedURLListener, handler: Handler = Handler(Looper.getMainLooper()))

Share the current authenticated session to a web browser. preAuthenticatedURLEnabled must be set to true to use this method.

makePreAuthenticatedURL

suspend fun Authgear.makePreAuthenticatedURL(options: PreAuthenticatedURLOptions): Uri

fun open(page: Page, options: SettingOptions? = null, listener: OnOpenURLListener? = null, handler: Handler = Handler(Looper.getMainLooper()))

Open the specific Page in web view.

fun openUrl(path: String, listener: OnOpenURLListener? = null, handler: Handler = Handler(Looper.getMainLooper()))

Open the specific path on the authgear server.

parseApp2AppAuthenticationRequest

@RequiresApi(api = 23)

fun parseApp2AppAuthenticationRequest(uri: Uri): App2AppAuthenticateRequest?

Parse an uri into app2app authentication request.

promoteAnonymousUser

fun promoteAnonymousUser(options: PromoteOptions, onPromoteAnonymousUserListener: OnPromoteAnonymousUserListener, handler: Handler = Handler(Looper.getMainLooper()))

Promote the current anonymous user. Note that this must not be called before there is an anonymous user.

promoteAnonymousUser

suspend fun Authgear.promoteAnonymousUser(options: PromoteOptions): UserInfo

fun reauthenticate(options: ReauthenticateOptions, biometricOptions: BiometricOptions?, listener: OnReauthenticateListener, handler: Handler = Handler(Looper.getMainLooper()))

Reauthenticate the user either by biometric or web.

refreshAccessTokenIfNeeded

fun refreshAccessTokenIfNeeded(onRefreshAccessTokenIfNeededListener: OnRefreshAccessTokenIfNeededListener, handler: Handler = Handler(Looper.getMainLooper()))

Refresh access token when necessary.

refreshAccessTokenIfNeededSync

fun refreshAccessTokenIfNeededSync(): String?

Refresh access token when necessary synchronously if needed. Do NOT call this on the main thread.

fun refreshIDToken(listener: OnRefreshIDTokenListener, handler: Handler = Handler(Looper.getMainLooper()))

Refresh ID token.

refreshTokenIfNeeded

suspend fun Authgear.refreshTokenIfNeeded(): String?

rejectApp2AppAuthenticationRequest

@RequiresApi(api = 23)

fun rejectApp2AppAuthenticationRequest(request: App2AppAuthenticateRequest, reason: Throwable, listener: OnHandleApp2AppAuthenticationRequestListener, handler: Handler = Handler(Looper.getMainLooper()))

Reject a app2app authentication request.

rejectApp2AppAuthenticationRequest

@RequiresApi(value = 23)

suspend fun Authgear.rejectApp2AppAuthenticationRequest(request: App2AppAuthenticateRequest, reason: Throwable)

startApp2AppAuthentication

@RequiresApi(api = 23)

fun startApp2AppAuthentication(options: App2AppAuthenticateOptions, onAuthenticateListener: OnAuthenticateListener, handler: Handler = Handler(Looper.getMainLooper()))

Start app2app authentication.

startApp2AppAuthentication

@RequiresApi(value = 23)

suspend fun Authgear.startApp2AppAuthentication(options: App2AppAuthenticateOptions): UserInfo

wechatAuthCallback

fun wechatAuthCallback(code: String, state: String, onWechatAuthCallbackListener: OnWechatAuthCallbackListener, handler: Handler = Handler(Looper.getMainLooper()))

WeChat auth callback function. In WeChat login flow, after returning from the WeChat SDK, this function should be called to complete the authorization.