Sensibill Auth/com.getsensibill.sensibillauth/SensibillAuth

SensibillAuth

Interface that defines the properties of SensibillAuth Objects. SensibillAuth objects are used to as a way to provide on-device authentication. Functionality includes ability to sign-in (user identifier + password, logout and register new users.

Types

AuthError

enum AuthError : Enum<SensibillAuth.AuthError>

AuthListener

interface AuthListener

Generic Authentication listener to monitor common authentication processes

Companion

object Companion

RegisterListener

interface RegisterListener

Listener to observe the user registration process

SaveExpiryTokensListener

interface SaveExpiryTokensListener

Listener to observe User Token storage during sign in.

SessionListener

interface SessionListener

Listener to observe User Sign-in process

Functions

checkPasswordStrength

open fun checkPasswordStrength(password: String, callback: RegistrationProvider.PasswordStrengthCallback)

Call to check if password provided is valid

abstract fun checkPasswordStrength(password: String, callback: RegistrationProvider.PasswordStrengthCallback, callbackScope: CoroutineScope)

forgotPassword

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

Call to send the user with the provided email a Reset Email notification

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

getCachedUser

abstract fun getCachedUser(accessId: String): SensibillUser?

Call to get a cached user

getCurrUserAccessId

abstract fun getCurrUserAccessId(): String?

Call to get the current user identifier

getTokenProvider

abstract fun getTokenProvider(): TokenProvider

Call to get current token provider attached to SDK

isSessionCached

abstract fun isSessionCached(accessId: String): Boolean

Call to check if a token is cached for the user with the provided user identifier

logout

open fun logout(accessToken: String, accessId: String, callback: SensibillAuth.AuthListener?)

Call to log-out of the SDK

abstract fun logout(accessToken: String, accessId: String, callback: SensibillAuth.AuthListener?, callbackScope: CoroutineScope)

registerWithPassword

open fun registerWithPassword(accessId: String, password: String, callback: SensibillAuth.RegisterListener)

Call to register a user with the provided access identifier and password.

abstract fun registerWithPassword(accessId: String, password: String, callback: SensibillAuth.RegisterListener, callbackScope: CoroutineScope)

registerWithUserInfo

open fun registerWithUserInfo(accessId: String, userInfo: UserInfo, callback: SensibillAuth.RegisterListener)

Call to register a user with the provided user information

abstract fun registerWithUserInfo(accessId: String, userInfo: UserInfo, callback: SensibillAuth.RegisterListener, callbackScope: CoroutineScope)

resetTemporaryPassword

open fun resetTemporaryPassword(accessId: String, temporaryPassword: String, newPassword: String, callback: SensibillAuth.AuthListener)

Call to reset the user with accessId's password with a provided new password

abstract fun resetTemporaryPassword(accessId: String, temporaryPassword: String, newPassword: String, callback: SensibillAuth.AuthListener, callbackScope: CoroutineScope)

signIn

open fun signIn(accessId: String, password: String, callback: SensibillAuth.SessionListener)

Call to sign in to the Sensibill SDK with the provided access identifier and password

abstract fun signIn(accessId: String, password: String, callback: SensibillAuth.SessionListener, callbackScope: CoroutineScope)

switchUser

abstract fun switchUser(accessId: String)

Call to change the cached user identifier to the provided access id

userExists

open fun userExists(accessId: String, callback: RegistrationProvider.AvailabilityCallback)

Call to check if a user with provided access id exists

abstract fun userExists(accessId: String, callback: RegistrationProvider.AvailabilityCallback, callbackScope: CoroutineScope)