OAuthProvider

interface OAuthProvider

This interface provides definitions for all methods required to interact with the Sensibill OAuth service.

Types

AccessTokenCallback

interface AccessTokenCallback

Companion

object Companion

ForgetPasswordCallback

interface ForgetPasswordCallback

LogoutCallback

interface LogoutCallback

Functions

authenticateUser

open fun authenticateUser(oauthSettings: OAuthSettings, username: String, password: String, callback: OAuthProvider.AccessTokenCallback)

Authenticates user using username and password, and returns User Session (AccessToken + RefreshToken + Token details, ie expiry) through AccessTokenCallback

abstract fun authenticateUser(oauthSettings: OAuthSettings, username: String, password: String, callback: OAuthProvider.AccessTokenCallback, callbackScope: CoroutineScope)

forgotPassword

open fun forgotPassword(email: String, callback: OAuthProvider.ForgetPasswordCallback)

Use to trigger Forgot Password email to user email

abstract fun forgotPassword(email: String, callback: OAuthProvider.ForgetPasswordCallback, callbackScope: CoroutineScope)

getClientToken

open fun getClientToken(oauthSettings: OAuthSettings, callback: OAuthProvider.AccessTokenCallback)

Use client settings to generate Client Access Token

abstract fun getClientToken(oauthSettings: OAuthSettings, callback: OAuthProvider.AccessTokenCallback, callbackScope: CoroutineScope)

logout

open fun logout(accessToken: String, logoutCallback: OAuthProvider.LogoutCallback)

Performs user logout, invalidates user access token

abstract fun logout(accessToken: String, logoutCallback: OAuthProvider.LogoutCallback, callbackScope: CoroutineScope)

refreshToken

open fun refreshToken(refreshToken: String, oauthSettings: OAuthSettings, accessTokenCallback: OAuthProvider.AccessTokenCallback)

Use refresh token to get new access token

abstract fun refreshToken(refreshToken: String, oauthSettings: OAuthSettings, accessTokenCallback: OAuthProvider.AccessTokenCallback, callbackScope: CoroutineScope)

Inheritors

OAuthProviderImpl