ReactNativeContainer
@authgear/react-native / ReactNativeContainer
Class: ReactNativeContainer
ReactNativeContainer is the entrypoint of the SDK. An instance of a container allows the user to authenticate, reauthenticate, etc.
Every container has a name.
The default name of a container is default.
If your app supports multi login sessions, you can use multiple containers with different names.
You are responsible for managing the list of names in this case.
Constructors
Constructor
new ReactNativeContainer(
options?):ReactNativeContainer
Parameters
options?
Returns
ReactNativeContainer
Properties
delegate?
optionaldelegate:ReactNativeContainerDelegate
Delegation for customizing the behavior of your application. You can implement your own delegation and the container will evaluate them if needed.
Accessors
accessToken
Get Signature
get accessToken():
string|undefined
The access token of this container.
Returns
string | undefined
Set Signature
set accessToken(
accessToken):void
Parameters
accessToken
string | undefined
Returns
void
clientID
Get Signature
get clientID():
string|undefined
OIDC client ID
Returns
string | undefined
Set Signature
set clientID(
clientID):void
Parameters
clientID
string | undefined
Returns
void
isSSOEnabled
Get Signature
get isSSOEnabled():
boolean
Is SSO enabled
Returns
boolean
Set Signature
set isSSOEnabled(
isSSOEnabled):void
Parameters
isSSOEnabled
boolean
Returns
void
name
Get Signature
get name():
string
The name of the container. The name is used as the namespace of TokenStorage.
One use case is to use multiple containers with different names to support signing in multiple accounts.
Default Value
"default"
@public
Returns
string
Set Signature
set name(
name):void
Parameters
name
string
Returns
void
preAuthenticatedURLEnabled
Get Signature
get preAuthenticatedURLEnabled():
boolean
Is Pre Authenticated URL enabled
Returns
boolean
Set Signature
set preAuthenticatedURLEnabled(
preAuthenticatedURLEnabled):void
Parameters
preAuthenticatedURLEnabled
boolean
Returns
void
sessionState
Get Signature
get sessionState():
SessionState
The current SessionState of this container.
Returns
Set Signature
set sessionState(
sessionState):void
Parameters
sessionState
Returns
void
Methods
addEmail()
addEmail(
options):Promise<void>
addEmail() opens the settings page in a UIImplementation for the user to add an email. After adding the email, the UIImplementation will be closed.
You can refer to SettingsActionOptions for more customization.
Parameters
options
Returns
Promise<void>
addPhone()
addPhone(
options):Promise<void>
addPhone() opens the settings page in a UIImplementation for the user to add a phone number. After adding the phone number, the UIImplementation will be closed.
You can refer to SettingsActionOptions for more customization.
Parameters
options
Returns
Promise<void>
addUsername()
addUsername(
options):Promise<void>
addUsername() opens the settings page in a UIImplementation for the user to add a username. After adding the username, the UIImplementation will be closed.
You can refer to SettingsActionOptions for more customization.
Parameters
options
Returns
Promise<void>
authenticate()
authenticate(
options):Promise<AuthenticateResult>
authenticate() starts the authentication process in a UIImplementation. After authentication, the UIImplementation will be closed and the user is logged in. After this method resolves, biometric authentication is disabled. Call enableBiometric() again to enable biometric authentication for the new signed in user.
You can refer to AuthenticateOptions for more customization.
Parameters
options
Returns
Promise<AuthenticateResult>
authenticateAnonymously()
authenticateAnonymously():
Promise<AuthenticateResult>
authenticateAnonymously() creates an anonymous user without showing any UI. You may first enable Anonymous Users in Authgear Portal (Your project > Authentication > Anonymous Users > Enable anonymous users).
Returns
Promise<AuthenticateResult>
authenticateBiometric()
authenticateBiometric(
options):Promise<AuthenticateResult>
Authenticate with biometric authentication. Platform specific biometric authentication UI will be shown. You may first enable biometric authentication in Authgear Portal (Your Project > Authentication > Biometric > Enable biometric authentication).
You can refer to BiometricOptions for more customization.
Parameters
options
Returns
Promise<AuthenticateResult>
canReauthenticate()
canReauthenticate():
boolean
canReauthenticate() reports whether the current user can reauthenticate. The information comes from the ID token and the ID token is NOT verified.
Returns
boolean
changeEmail()
changeEmail(
originalEmail,options):Promise<void>
changeEmail() opens the settings page in a UIImplementation for the user to change their email. After changing the email, the UIImplementation will be closed.
You can refer to SettingsActionOptions for more customization.
Parameters
originalEmail
string
options
Returns
Promise<void>
changePassword()
changePassword(
options):Promise<void>
changePassword() opens the settings page in a UIImplementation for the user to change their password. After changing the password, the UIImplementation will be closed.
You can refer to SettingsActionOptions for more customization.
Parameters
options
Returns
Promise<void>
changePhone()
changePhone(
originalPhone,options):Promise<void>
changePhone() opens the settings page in a UIImplementation for the user to change their phone number. After changing the phone number, the UIImplementation will be closed.
You can refer to SettingsActionOptions for more customization.
Parameters
originalPhone
string
options
Returns
Promise<void>
changeUsername()
changeUsername(
originalUsername,options):Promise<void>
changeUsername() opens the settings page in a UIImplementation for the user to change their username. After changing the username, the UIImplementation will be closed.
You can refer to SettingsActionOptions for more customization.
Parameters
originalUsername
string
options
Returns
Promise<void>
checkBiometricSupported()
checkBiometricSupported(
options):Promise<void>
Check whether biometric is supported on the current device. If biometric is not supported, then a platform specific error is thrown.
Parameters
options
Returns
Promise<void>
configure()
configure(
options):Promise<void>
configure() configures the container with the client ID and the endpoint. It also does local IO to retrieve the refresh token. It only obtains the refresh token locally and no network call will be triggered. So the session state maybe outdated for some reason, e.g. user session is revoked. fetchUserInfo should be called to obtain the latest user session state.
configure() can be called more than once if it failed. Otherwise, it is NOT recommended to call it more than once.
Parameters
options
Returns
Promise<void>
deleteAccount()
deleteAccount(
options):Promise<void>
deleteAccount() opens the settings page in a UIImplementation for the user to delete their account. After deletion, the UIImplementation will be closed and the user is logged out.
You can refer to SettingsActionOptions for more customization.
Parameters
options
Returns
Promise<void>
disableBiometric()
disableBiometric():
Promise<void>
Disable biometric authentication for the signed in user. After disabling, the user may not be able to authenticate with biometric until it is enabled again.
Returns
Promise<void>
enableBiometric()
enableBiometric(
options):Promise<void>
Enable biometric authentication for the signed in user. Platform specific biometric authentication UI will be shown. You may first enable biometric authentication in Authgear Portal (Your Project > Authentication > Biometric > Enable biometric authentication).
You can refer to BiometricOptions for more customization.
Parameters
options
Returns
Promise<void>
fetch()
fetch(
input,init?):Promise<Response>
Fetch function for you to call your application server. The fetch function will include Authorization header in your application request, and handle refresh access token automatically.
Parameters
input
any
init?
RequestInit
Returns
Promise<Response>
fetchUserInfo()
fetchUserInfo():
Promise<UserInfo>
fetchUserInfo() fetches the up-to-date user info.
Returns
Promise<UserInfo>
getAuthTime()
getAuthTime():
Date|undefined
getAuthTime() reports the last time the user was authenticated. The information comes from the ID token and the ID token is NOT verified.
Returns
Date | undefined
getIDTokenHint()
getIDTokenHint():
string|undefined
getIDTokenHint() returns the ID token for the OIDC id_token_hint parameter.
Returns
string | undefined
isBiometricEnabled()
isBiometricEnabled():
Promise<boolean>
Check whether biometric was enabled for the signed in user.
Returns
Promise<boolean>
logout()
logout(
options?):Promise<void>
logout() signs out the user without showing any UI. The refresh token will be cleared. The biometric authentication is kept, so the user can authenticateBiometric again.
Parameters
options?
Logout options
force?
boolean
Returns
Promise<void>
Remarks
If force parameter is set to true, all potential errors (e.g. network
error) would be ignored.
makePreAuthenticatedURL()
makePreAuthenticatedURL(
options):Promise<string>
Share the current authenticated session to a web browser.
ConfigureOptions.preAuthenticatedURLEnabled must be set to true to use this method.
You can refer to PreAuthenticatedURLOptions for more customization.
Parameters
options
Returns
Promise<string>
open()
open(
page,options?):Promise<void>
Open Authgear pages. Currently only settings pages are available.
You can refer to SettingOptions for more customization.
Parameters
page
options?
Returns
Promise<void>
promoteAnonymousUser()
promoteAnonymousUser(
options):Promise<AuthenticateResult>
promoteAnonymousUser() opens the anonymous user promotion page in the UIImplementation and the user has to authenticate. The flow is similar to authenticate(), the UIImplementation will be closed and the user is logged in after authentication. After this method resolves, biometric authentication is disabled. Call enableBiometric() again to enable biometric authentication for the new signed in user.
You can refer to PromoteOptions for more customization.
Parameters
options
Returns
Promise<AuthenticateResult>
reauthenticate()
reauthenticate(
options,biometricOptions?):Promise<ReauthenticateResult>
reauthenticate() starts the reauthentication process via biometric or in the UIImplementation.
If biometricOptions is given, biometric is used when possible.
You can refer to ReauthenticateOptions and BiometricOptions for more customization.
Parameters
options
biometricOptions?
Returns
Promise<ReauthenticateResult>
refreshAccessTokenIfNeeded()
refreshAccessTokenIfNeeded():
Promise<void>
refreshAccessTokenIfNeeded() refreshes the access token if needed. After the task has completed, the updated access token will be stored in this.accessToken.
Returns
Promise<void>
refreshIDToken()
refreshIDToken():
Promise<void>
refreshIDToken() asks the server to issue an ID token with latest claims. After refreshing, getIDTokenHint() and canReauthenticate() may return up-to-date value.
Returns
Promise<void>
wechatAuthCallback()
wechatAuthCallback(
code,state):Promise<void>
WeChat auth callback function. In WeChat login flow, after returning from the WeChat SDK, this function should be called to complete the authorization.
Parameters
code
string
WeChat Authorization code.
state
string
WeChat Authorization state.
Returns
Promise<void>