modules
@authgear/react-native / Exports
@authgear/react-native
#
Table of contents#
Enumerations#
Classes- AuthgearError
- BiometricLockoutError
- BiometricNoEnrollmentError
- BiometricNoPasscodeError
- BiometricNotSupportedOrPermissionDeniedError
- BiometricPrivateKeyNotFoundError
- CancelError
- OAuthError
- PersistentTokenStorage
- ReactNativeContainer
- ServerError
- TransientTokenStorage
#
Interfaces- AuthorizeOptions
- AuthorizeResult
- BiometricOptions
- BiometricPrivateKeyOptions
- BiometricPrivateKeyOptionsAndroid
- BiometricPrivateKeyOptionsIOS
- ConfigureOptions
- ContainerOptions
- PromoteOptions
- ReactNativeContainerDelegate
- ReauthenticateOptions
- ReauthenticateResult
- SettingOptions
- TokenStorage
- UserInfo
#
Type aliases- BiometricAccessConstraintAndroid
- BiometricAccessConstraintIOS
- ErrorName
- PromptOption
- SessionState
- SessionStateChangeReason
#
Variables#
Type aliases#
BiometricAccessConstraintAndroidƬ BiometricAccessConstraintAndroid: "BIOMETRIC_STRONG"
| "DEVICE_CREDENTIAL"
#
Defined inpackages/authgear-react-native/index.d.ts:283
#
BiometricAccessConstraintIOSƬ BiometricAccessConstraintIOS: "biometryAny"
| "biometryCurrentSet"
| "userPresence"
#
Defined inpackages/authgear-react-native/index.d.ts:288
#
ErrorNameƬ ErrorName: typeof ErrorNames
[keyof typeof ErrorNames
]
ErrorName is the union of the keys of ErrorNames.
#
Defined inpackages/authgear-react-native/index.d.ts:55
#
PromptOptionƬ PromptOption: "none"
| "login"
| "consent"
| "select_account"
Prompt parameter options.
#
Defined inpackages/authgear-react-native/index.d.ts:98
#
SessionStateƬ SessionState: "UNKNOWN"
| "NO_SESSION"
| "AUTHENTICATED"
The session state.
An freshly constructed instance has the session state "UNKNOWN";
After a call to configure, the session state would become "AUTHENTICATED" if a previous session was found, or "NO_SESSION" if such session was not found.
#
Defined inpackages/authgear-react-native/index.d.ts:160
#
SessionStateChangeReasonƬ SessionStateChangeReason: "NO_TOKEN"
| "FOUND_TOKEN"
| "AUTHENTICATED"
| "LOGOUT"
| "INVALID"
| "CLEAR"
The reason why SessionState is changed.
These reasons can be thought of as the transition of a SessionState, which is described as follows:
LOGOUT / INVALID +----------------------------------------------+ v | State: UNKNOWN ----- NO_TOKEN ----> State: NO_SESSION ---- AUTHENTICATED -----> State: AUTHENTICATED | ^ +--------------------------------------------------------------------------------+ FOUND_TOKEN
#
Defined inpackages/authgear-react-native/index.d.ts:178
#
Variables#
ErrorNames• Const
ErrorNames: Object
ErrorNames contains all possible name in ServerError
#
Type declarationName | Type |
---|---|
AlreadyExists | "AlreadyExists" |
BadRequest | "BadRequest" |
Forbidden | "Forbidden" |
InternalError | "InternalError" |
Invalid | "Invalid" |
NotFound | "NotFound" |
ServiceUnavailable | "ServiceUnavailable" |
TooManyRequest | "TooManyRequest" |
Unauthorized | "Unauthorized" |
#
Defined inpackages/authgear-react-native/index.d.ts:62
#
VERSION• Const
VERSION: string
#
Defined inpackages/authgear-react-native/index.d.ts:226
#
default• Const
default: ReactNativeContainer
Default container.
remarks
This is a global shared container, provided for convenience.
#
Defined inpackages/authgear-react-native/index.d.ts:407