sdk/com.oursky.authgear

Package-level declarations

Types

class AnonymousUserNotFoundException : AuthgearException

data class AuthenticateOptions @JvmOverloads constructor(var redirectUri: String, var state: String? = null, var xState: String? = null, var responseType: String? = "code", var prompt: List<PromptOption>? = null, var loginHint: String? = null, var uiLocales: List<String>? = null, var colorScheme: ColorScheme? = null, var wechatRedirectURI: String? = null, var page: String? = null, var authenticationFlowGroup: String? = null)

Authorization options.

AuthenticationRequest

data class AuthenticationRequest

Authgear

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

AuthgearDelegate

interface AuthgearDelegate

AuthgearException

open class AuthgearException : RuntimeException

BiometricCanAuthenticateException

class BiometricCanAuthenticateException(val result: Int) : AuthgearException

BiometricLockoutException

class BiometricLockoutException : AuthgearException

BiometricNoEnrollmentException

class BiometricNoEnrollmentException : AuthgearException

BiometricNoPasscodeException

class BiometricNoPasscodeException : AuthgearException

BiometricNotSupportedOrPermissionDeniedException

class BiometricNotSupportedOrPermissionDeniedException : AuthgearException

BiometricOptions

data class BiometricOptions(var activity: FragmentActivity, var title: String, var subtitle: String, var description: String, var negativeButtonText: String, var allowedAuthenticators: Int, var invalidatedByBiometricEnrollment: Boolean)

BiometricPrivateKeyNotFoundException

class BiometricPrivateKeyNotFoundException : AuthgearException

BiometricPromptAuthenticationException

class BiometricPromptAuthenticationException(val errorCode: Int) : AuthgearException

CancelException

class CancelException : AuthgearException

ColorScheme

enum ColorScheme : Enum<ColorScheme>

CustomTabsUIImplementation

class CustomTabsUIImplementation : UIImplementation

ExperimentalAuthgearApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.CONSTRUCTOR])

annotation class ExperimentalAuthgearApi

GrantType

@Serializable(with = GrantTypeSerializer::class)

enum GrantType : Enum<GrantType>

GrantTypeSerializer

@Serializer(forClass = GrantType::class)

object GrantTypeSerializer : KSerializer<GrantType>

OAuthException

class OAuthException : AuthgearException

OAuthRedirectActivity

class OAuthRedirectActivity : AppCompatActivity

An activity to be declared by user in their app's manifest to handle redirect deep link.

OnAuthenticateAnonymouslyListener

interface OnAuthenticateAnonymouslyListener

OnAuthenticateBiometricListener

interface OnAuthenticateBiometricListener

OnAuthenticateListener

interface OnAuthenticateListener

OnConfigureListener

interface OnConfigureListener

OnCreateAuthenticationRequestListener

interface OnCreateAuthenticationRequestListener

OnEnableBiometricListener

interface OnEnableBiometricListener

OnFetchUserInfoListener

interface OnFetchUserInfoListener

OnGenerateURLListener

interface OnGenerateURLListener

OnHandleApp2AppAuthenticationRequestListener

interface OnHandleApp2AppAuthenticationRequestListener

OnLogoutListener

interface OnLogoutListener

OnOpenAuthorizationURLListener

interface OnOpenAuthorizationURLListener

OnOpenSettingsActionListener

interface OnOpenSettingsActionListener

OnOpenURLListener

interface OnOpenURLListener

OnPromoteAnonymousUserListener

interface OnPromoteAnonymousUserListener

OnReauthenticateListener

interface OnReauthenticateListener

OnRefreshAccessTokenIfNeededListener

interface OnRefreshAccessTokenIfNeededListener

OnRefreshIDTokenListener

interface OnRefreshIDTokenListener

OnWechatAuthCallbackListener

interface OnWechatAuthCallbackListener

OpenAuthorizationURLOptions

class OpenAuthorizationURLOptions(val url: Uri, val redirectURI: Uri)

Page

enum Page : Enum<Page>

The page to open in external browser.

PersistentTokenStorage

class PersistentTokenStorage(val context: Context) : TokenStorage

PromoteOptions

data class PromoteOptions @JvmOverloads constructor(var redirectUri: String, var state: String? = null, var xState: String? = null, var uiLocales: List<String>? = null, var colorScheme: ColorScheme? = null, var wechatRedirectURI: String? = null)

PromptOption

enum PromptOption : Enum<PromptOption>

ReauthenticateOptions

data class ReauthenticateOptions @JvmOverloads constructor(var redirectUri: String, var state: String? = null, var xState: String? = null, var uiLocales: List<String>? = null, var colorScheme: ColorScheme? = null, var maxAge: Int? = null, var wechatRedirectURI: String? = null, var authenticationFlowGroup: String? = null)

Reauthentication options.

ServerException

class ServerException(val name: String, val reason: String, message: String, val info: JSONObject? = null) : AuthgearException

SessionState

enum SessionState : Enum<SessionState>

The session state.

SessionStateChangeReason

enum SessionStateChangeReason : Enum<SessionStateChangeReason>

The reason why SessionState is changed.

SettingOptions

data class SettingOptions @JvmOverloads constructor(var wechatRedirectURI: String? = null, var colorScheme: ColorScheme? = null, var uiLocales: List<String>? = null)

SettingsAction

enum SettingsAction : Enum<SettingsAction>

SettingsActionOptions

data class SettingsActionOptions @JvmOverloads constructor(var redirectURI: String, var wechatRedirectURI: String? = null, var colorScheme: ColorScheme? = null, var uiLocales: List<String>? = null)

TokenStorage

interface TokenStorage

TransientTokenStorage

class TransientTokenStorage : TokenStorage

UIImplementation

interface UIImplementation

UILocales

object UILocales

UnauthenticatedUserException

class UnauthenticatedUserException : AuthgearException

UserInfo

@Serializable

data class UserInfo(val sub: String, val isVerified: Boolean, val isAnonymous: Boolean, val canReauthenticate: Boolean, val roles: Array<String>? = null, val customAttributes: JsonObject, val email: String? = null, val emailVerified: Boolean? = null, val phoneNumber: String? = null, val phoneNumberVerified: Boolean? = null, val preferredUsername: String? = null, val familyName: String? = null, val givenName: String? = null, val middleName: String? = null, val name: String? = null, val nickname: String? = null, val picture: String? = null, val profile: String? = null, val website: String? = null, val gender: String? = null, val birthdate: String? = null, val zoneinfo: String? = null, val locale: String? = null, val address: UserInfoAddress? = null)

UserInfoAddress

@Serializable

data class UserInfoAddress(val formatted: String? = null, val streetAddress: String? = null, val locality: String? = null, val region: String? = null, val postalCode: String? = null, val country: String? = null)

WebKitWebViewActivity

class WebKitWebViewActivity : AppCompatActivity

WebKitWebViewUIImplementation