CapacitorContainer
@authgear/capacitor / CapacitorContainer
Class: CapacitorContainer
CapacitorContainer 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.
Table of contents
Constructors
Properties
Accessors
Methods
- authenticate
- authenticateBiometric
- canReauthenticate
- changePassword
- checkBiometricSupported
- configure
- disableBiometric
- enableBiometric
- fetch
- fetchUserInfo
- getAuthTime
- getIDTokenHint
- isBiometricEnabled
- logout
- open
- reauthenticate
- refreshAccessTokenIfNeeded
- refreshIDToken
Constructors
constructor
• new CapacitorContainer(options?
)
Parameters
Name | Type |
---|---|
options? | ContainerOptions |
Defined in
packages/authgear-capacitor/index.d.ts:579
Properties
delegate
• Optional
delegate: CapacitorContainerDelegate
Defined in
packages/authgear-capacitor/index.d.ts:545
Accessors
accessToken
• get
accessToken(): undefined
| string
Returns
undefined
| string
Defined in
packages/authgear-capacitor/index.d.ts:578
clientID
• get
clientID(): undefined
| string
OIDC client ID
Returns
undefined
| string
Defined in
packages/authgear-capacitor/index.d.ts:560
• set
clientID(clientID
): void
Parameters
Name | Type |
---|---|
clientID | undefined | string |
Returns
void
Defined in
packages/authgear-capacitor/index.d.ts:561
isSSOEnabled
• get
isSSOEnabled(): boolean
Is SSO enabled
Returns
boolean
Defined in
packages/authgear-capacitor/index.d.ts:567
• set
isSSOEnabled(isSSOEnabled
): void
Parameters
Name | Type |
---|---|
isSSOEnabled | boolean |
Returns
void
Defined in
packages/authgear-capacitor/index.d.ts:568
name
• get
name(): string
Unique ID for this container.
Default Value
"default"
Returns
string
Defined in
packages/authgear-capacitor/index.d.ts:553
• set
name(name
): void
Parameters
Name | Type |
---|---|
name | string |
Returns
void
Defined in
packages/authgear-capacitor/index.d.ts:554
sessionState
• get
sessionState(): SessionState
Returns
Defined in
packages/authgear-capacitor/index.d.ts:573
Methods
authenticate
▸ authenticate(options
): Promise
<AuthenticateResult
>
Authenticate the end user via the web.
Parameters
Name | Type |
---|---|
options | AuthenticateOptions |
Returns
Promise
<AuthenticateResult
>
Defined in
packages/authgear-capacitor/index.d.ts:655
authenticateBiometric
▸ authenticateBiometric(options
): Promise
<AuthenticateResult
>
Parameters
Name | Type |
---|---|
options | BiometricOptions |
Returns
Promise
<AuthenticateResult
>
Defined in
packages/authgear-capacitor/index.d.ts:682
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
Defined in
packages/authgear-capacitor/index.d.ts:592
changePassword
▸ changePassword(options
): Promise
<void
>
Parameters
Name | Type |
---|---|
options | SettingsActionOptions |
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:671
checkBiometricSupported
▸ checkBiometricSupported(options
): Promise
<void
>
Parameters
Name | Type |
---|---|
options | BiometricOptions |
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:675
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
Name | Type |
---|---|
options | ConfigureOptions |
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:613
disableBiometric
▸ disableBiometric(): Promise
<void
>
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:680
enableBiometric
▸ enableBiometric(options
): Promise
<void
>
Parameters
Name | Type |
---|---|
options | BiometricOptions |
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:681
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
Name | Type |
---|---|
input | RequestInfo |
init? | RequestInit |
Returns
Promise
<Response
>
Defined in
packages/authgear-capacitor/index.d.ts:637
fetchUserInfo
▸ fetchUserInfo(): Promise
<UserInfo
>
Fetch user info.
Returns
Promise
<UserInfo
>
Defined in
packages/authgear-capacitor/index.d.ts:629
getAuthTime
▸ getAuthTime(): undefined
| Date
getAuthTime() reports the last time the user was authenticated. The information comes from the ID token and the ID token is NOT verified.
Returns
undefined
| Date
Defined in
packages/authgear-capacitor/index.d.ts:599
getIDTokenHint
▸ getIDTokenHint(): undefined
| string
getIDTokenHint() returns the ID token for the OIDC id_token_hint parameter.
Returns
undefined
| string
Defined in
packages/authgear-capacitor/index.d.ts:585
isBiometricEnabled
▸ isBiometricEnabled(): Promise
<boolean
>
Returns
Promise
<boolean
>
Defined in
packages/authgear-capacitor/index.d.ts:679
logout
▸ logout(options?
): Promise
<void
>
Logout.
Remarks
If force
parameter is set to true
, all potential errors (e.g. network
error) would be ignored.
Parameters
Name | Type | Description |
---|---|---|
options? | Object | Logout options |
options.force? | boolean | - |
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:647
open
▸ open(page
, options?
): Promise
<void
>
Parameters
Name | Type |
---|---|
page | Page |
options? | SettingOptions |
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:667
reauthenticate
▸ reauthenticate(options
, biometricOptions?
): Promise
<ReauthenticateResult
>
Reauthenticate the end user via biometric or the web.
If biometricOptions is given, biometric is used when possible.
Parameters
Name | Type |
---|---|
options | ReauthenticateOptions |
biometricOptions? | BiometricOptions |
Returns
Promise
<ReauthenticateResult
>
Defined in
packages/authgear-capacitor/index.d.ts:663
refreshAccessTokenIfNeeded
▸ refreshAccessTokenIfNeeded(): Promise
<void
>
Returns
Promise
<void
>
Defined in
packages/authgear-capacitor/index.d.ts:624
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
>
Defined in
packages/authgear-capacitor/index.d.ts:620