From c2516dc186374843164a52e7f9a2a0847c3d5d42 Mon Sep 17 00:00:00 2001
From: Sai Venkat Desu
- the text to use as title in the authentication screen.
- Passing null will result in using the OS's default
- value in Android and "Please authenticate to
- continue" in iOS.
-
- Android only: the text to use as
- description in the authentication screen. On some
- Android versions it might not be shown. Passing null
- will result in using the OS's default value.
-
- iOS only: the cancel message to
- display on the local authentication prompt.
-
- iOS only: the fallback message to
- display on the local authentication prompt after a
- failed match.
-
- iOS only: the evaluation policy to
- use when accessing the credentials. Defaults to
- LocalAuthenticationStrategy.deviceOwnerWithBiometrics.
- Hierarchy
>Auth0Provider
+
See
See
See
See
See
See
See
>Auth0Provider
+
Hierarchy
>Auth0Provider
+
Class CredentialsManager
Properties
domain
+ localMethods
has
+
+
+
+ Private
+ Optional
+ localMethods
@@ -295,8 +330,8 @@
- require
-
-
@@ -925,6 +802,13 @@ Parameters
-
-
-
-
- Optional
- title:
- string
-
-
- Optional
- description:
- string
-
-
- Optional
- cancelTitle:
- string
-
-
- Optional
- fallbackTitle:
- string
-
- strategy:
- LocalAuthenticationStrategy
- =
- LocalAuthenticationStrategy.deviceOwnerWithBiometrics
-
-
- Returns Promise<void>
-
-
-
>domain
+
See
Memberof
Memberof
>Auth0Provider
+
See
Properties
domain
+ local
+
+
+ Private
+ Optional
+ local
{
"expo": {
...
"plugins": [
[
"react-native-auth0",
{
"domain": "YOUR_AUTH0_DOMAIN",
"customScheme": "YOUR_CUSTOM_SCHEME"
}
]
]
}
}
+ ++ :info: If you want to switch between multiple domains in your app, + refer + here +
+
Property | +Type | +Description | +Applicable Platforms | +
---|---|---|---|
title |
+ String |
+ The title of the authentication prompt. | +Android, iOS | +
subtitle |
+ String (optional) |
+ The subtitle of the authentication prompt. | +Android | +
description |
+ String (optional) |
+ The description of the authentication prompt. | +Android | +
cancelTitle |
+ String (optional) |
+ The cancel button title of the authentication prompt. | +Android, iOS | +
evaluationPolicy |
+ LocalAuthenticationStrategy (optional) |
+
+ The evaluation policy to use when prompting the user for
+ authentication. Defaults to
+ deviceOwnerWithBiometrics .
+ |
+ iOS | +
fallbackTitle |
+ String (optional) |
+ The fallback button title of the authentication prompt. | +iOS | +
authenticationLevel |
+ LocalAuthenticationLevel (optional) |
+
+ The authentication level to use when prompting the user for
+ authentication. Defaults to strong .
+ |
+ Android | +
deviceCredentialFallback |
+ Boolean (optional) |
+ + Should the user be given the option to authenticate with their + device PIN, pattern, or password instead of a biometric. + | +Android | +
:warning: You need a real device to test Local Authentication for @@ -1130,8 +1257,12 @@
>
- Local authenticationRequiring Authentication before + obtaining Credentials @@ -1201,6 +1332,13 @@ +>Auth0Provider
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/AuthorizeUrlOptions.html b/docs/interfaces/AuthorizeUrlOptions.html index e1d96e5a..e642b721 100644 --- a/docs/interfaces/AuthorizeUrlOptions.html +++ b/docs/interfaces/AuthorizeUrlOptions.html @@ -113,7 +113,7 @@Indexable
Defined in types.ts:205 @@ -196,7 +196,7 @@
Defined in types.ts:213 @@ -228,7 +228,7 @@
Defined in types.ts:209 @@ -257,7 +257,7 @@
Defined in types.ts:217 @@ -454,6 +454,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/ClearSessionOptions.html b/docs/interfaces/ClearSessionOptions.html index 901a0144..c771fc05 100644 --- a/docs/interfaces/ClearSessionOptions.html +++ b/docs/interfaces/ClearSessionOptions.html @@ -91,7 +91,7 @@Interface ClearSessionOptions
Defined in types.ts:180 @@ -170,7 +170,7 @@
Defined in types.ts:184 @@ -211,7 +211,7 @@
Defined in types.ts:188 @@ -401,6 +401,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/ClearSessionParameters.html b/docs/interfaces/ClearSessionParameters.html index d5bc04ab..1a0ebe57 100644 --- a/docs/interfaces/ClearSessionParameters.html +++ b/docs/interfaces/ClearSessionParameters.html @@ -91,7 +91,7 @@Interface ClearSessionParameters
Defined in types.ts:156 @@ -178,7 +178,7 @@See
Defined in types.ts:162 @@ -229,7 +229,7 @@
Defined in types.ts:174 @@ -419,6 +419,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/CreateUserOptions.html b/docs/interfaces/CreateUserOptions.html index 2a8eda17..038208ef 100644 --- a/docs/interfaces/CreateUserOptions.html +++ b/docs/interfaces/CreateUserOptions.html @@ -142,7 +142,7 @@Indexable
Defined in types.ts:537 @@ -271,7 +271,7 @@
Defined in types.ts:549 @@ -300,7 +300,7 @@
Defined in types.ts:541 @@ -333,7 +333,7 @@
Defined in types.ts:561 @@ -366,7 +366,7 @@
Defined in types.ts:557 @@ -402,7 +402,7 @@
Defined in types.ts:577 @@ -432,7 +432,7 @@
Defined in types.ts:565 @@ -465,7 +465,7 @@
Defined in types.ts:569 @@ -497,7 +497,7 @@
Defined in types.ts:545 @@ -527,7 +527,7 @@
Defined in types.ts:573 @@ -560,7 +560,7 @@
Defined in types.ts:553 @@ -806,6 +806,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/ExchangeNativeSocialOptions.html b/docs/interfaces/ExchangeNativeSocialOptions.html index 263035b6..70ac7d6e 100644 --- a/docs/interfaces/ExchangeNativeSocialOptions.html +++ b/docs/interfaces/ExchangeNativeSocialOptions.html @@ -132,7 +132,7 @@Indexable
Defined in types.ts:271 @@ -227,7 +227,7 @@
Defined in types.ts:287 @@ -260,7 +260,7 @@
Defined in types.ts:291 @@ -294,7 +294,7 @@
Defined in types.ts:275 @@ -330,7 +330,7 @@
Defined in types.ts:279 @@ -366,7 +366,7 @@
Defined in types.ts:283 @@ -577,6 +577,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/ExchangeOptions.html b/docs/interfaces/ExchangeOptions.html index 62a93e43..86ab1246 100644 --- a/docs/interfaces/ExchangeOptions.html +++ b/docs/interfaces/ExchangeOptions.html @@ -111,7 +111,7 @@Indexable
Defined in types.ts:249 @@ -186,7 +186,7 @@
Defined in types.ts:253 @@ -221,7 +221,7 @@
Defined in types.ts:261 @@ -256,7 +256,7 @@
Defined in types.ts:257 @@ -453,6 +453,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/GetUserOptions.html b/docs/interfaces/GetUserOptions.html index 60bda890..10dc2c46 100644 --- a/docs/interfaces/GetUserOptions.html +++ b/docs/interfaces/GetUserOptions.html @@ -88,7 +88,7 @@Indexable
Defined in types.ts:191 @@ -145,7 +145,7 @@
Defined in types.ts:192 @@ -328,6 +328,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/LocalAuthenticationOptions.html b/docs/interfaces/LocalAuthenticationOptions.html new file mode 100644 index 00000000..7c10c573 --- /dev/null +++ b/docs/interfaces/LocalAuthenticationOptions.html @@ -0,0 +1,1323 @@ + + + + + +LocalAuthenticationOptions | react-native-auth0 + + + + + + + + + + ++ + +++++ +++ +Interface LocalAuthenticationOptions
++ +++ ++ The options for configuring the display of local authentication + prompt, authentication level (Android only) and evaluation policy + (iOS only). +
++ interface LocalAuthenticationOptions {+
authenticationLevel?: LocalAuthenticationLevel;
cancelTitle?: String;
description?: String;
deviceCredentialFallback?: Boolean;
evaluationPolicy?: LocalAuthenticationStrategy;
fallbackTitle?: String;
subtitle?: String;
title: String;
} ++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:8 +
++ ++ ++++
++ + Index +
++++ +Properties
+ ++ +Properties
++ + ++
+ +Optional
+ authenticationLevel + ++ ++ The authentication level to use when prompting the user for + authentication. Defaults to LocalAuthenticationLevel.strong. + Applicable for Android only. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:36 +
++ + ++
+Optional
+ cancelTitle + + cancel+Title?: + String + ++ ++ The cancel button title of the authentication prompt. + Applicable for both Android and iOS. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:24 +
++ + ++
+Optional
+ description ++ description?: + String ++++ ++ The description of the authentication prompt. + Applicable for Android only. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:20 +
++ + ++
+Optional
+ deviceCredential Fallback + + device+Credential Fallback?: + Boolean + ++ ++ Should the user be given the option to authenticate with their + device PIN, pattern, or password instead of a biometric. + Applicable for Android only. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:40 +
++ + ++
+ +Optional
+ evaluationPolicy + ++ ++ The evaluation policy to use when prompting the user for + authentication. Defaults to + LocalAuthenticationStrategy.deviceOwnerWithBiometrics. + Applicable for iOS only. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:28 +
++ + ++
+Optional
+ fallbackTitle + + fallback+Title?: + String + ++ ++ The fallback button title of the authentication prompt. + Applicable for iOS only. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:32 +
++ + ++
+Optional
+ subtitle ++ subtitle?: + String ++++ ++ The subtitle of the authentication prompt. + Applicable for Android only. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:16 +
++ + ++ title +
++ title: + String ++++ ++ The title of the authentication prompt. + Applicable for both Android and iOS. +
++ ++
+- + Defined in + credentials-manager/localAuthenticationOptions.ts:12 +
+++ + + + diff --git a/docs/interfaces/LoginWithEmailOptions.html b/docs/interfaces/LoginWithEmailOptions.html index 4b5ac975..4a58c659 100644 --- a/docs/interfaces/LoginWithEmailOptions.html +++ b/docs/interfaces/LoginWithEmailOptions.html @@ -117,7 +117,7 @@+ Generated using + TypeDoc +
+Indexable
Defined in types.ts:378 @@ -205,7 +205,7 @@
Defined in types.ts:390 @@ -234,7 +234,7 @@
Defined in types.ts:386 @@ -263,7 +263,7 @@
Defined in types.ts:382 @@ -293,7 +293,7 @@
Defined in types.ts:394 @@ -497,6 +497,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/LoginWithOOBOptions.html b/docs/interfaces/LoginWithOOBOptions.html index fb24440f..7f6295f3 100644 --- a/docs/interfaces/LoginWithOOBOptions.html +++ b/docs/interfaces/LoginWithOOBOptions.html @@ -107,7 +107,7 @@Indexable
Defined in types.ts:444 @@ -193,7 +193,7 @@
Defined in types.ts:458 @@ -225,7 +225,7 @@
Defined in types.ts:448 @@ -254,7 +254,7 @@
Defined in types.ts:452 @@ -451,6 +451,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/LoginWithOTPOptions.html b/docs/interfaces/LoginWithOTPOptions.html index 0286cc9b..dd80c5b1 100644 --- a/docs/interfaces/LoginWithOTPOptions.html +++ b/docs/interfaces/LoginWithOTPOptions.html @@ -105,7 +105,7 @@Indexable
Defined in types.ts:424 @@ -186,7 +186,7 @@
Defined in types.ts:437 @@ -218,7 +218,7 @@
Defined in types.ts:428 @@ -251,7 +251,7 @@
Defined in types.ts:433 @@ -448,6 +448,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/LoginWithRecoveryCodeOptions.html b/docs/interfaces/LoginWithRecoveryCodeOptions.html index b3043e15..4bf3d135 100644 --- a/docs/interfaces/LoginWithRecoveryCodeOptions.html +++ b/docs/interfaces/LoginWithRecoveryCodeOptions.html @@ -108,7 +108,7 @@Indexable
Defined in types.ts:465 @@ -181,7 +181,7 @@
Defined in types.ts:469 @@ -213,7 +213,7 @@
Defined in types.ts:473 @@ -403,6 +403,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/LoginWithSMSOptions.html b/docs/interfaces/LoginWithSMSOptions.html index 7c40ed88..4a17e777 100644 --- a/docs/interfaces/LoginWithSMSOptions.html +++ b/docs/interfaces/LoginWithSMSOptions.html @@ -114,7 +114,7 @@Indexable
Defined in types.ts:401 @@ -202,7 +202,7 @@
Defined in types.ts:413 @@ -231,7 +231,7 @@
Defined in types.ts:409 @@ -263,7 +263,7 @@
Defined in types.ts:405 @@ -293,7 +293,7 @@
Defined in types.ts:417 @@ -497,6 +497,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 6e5ff970..89a3dbdf 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -109,7 +109,7 @@Indexable
Defined in types.ts:227 @@ -190,7 +190,7 @@
Defined in types.ts:235 @@ -226,7 +226,7 @@
Defined in types.ts:231 @@ -262,7 +262,7 @@
Defined in types.ts:239 @@ -459,6 +459,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/MultifactorChallengeOptions.html b/docs/interfaces/MultifactorChallengeOptions.html index 351f2f22..54a5c6c3 100644 --- a/docs/interfaces/MultifactorChallengeOptions.html +++ b/docs/interfaces/MultifactorChallengeOptions.html @@ -115,7 +115,7 @@Indexable
Defined in types.ts:480 @@ -196,7 +196,7 @@
Defined in types.ts:494 @@ -234,7 +234,7 @@
Defined in types.ts:490 @@ -266,7 +266,7 @@
Defined in types.ts:484 @@ -463,6 +463,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/PasswordRealmOptions.html b/docs/interfaces/PasswordRealmOptions.html index b1bada6f..a3f43c7f 100644 --- a/docs/interfaces/PasswordRealmOptions.html +++ b/docs/interfaces/PasswordRealmOptions.html @@ -126,7 +126,7 @@Indexable
Defined in types.ts:298 @@ -224,7 +224,7 @@
Defined in types.ts:314 @@ -256,7 +256,7 @@
Defined in types.ts:306 @@ -285,7 +285,7 @@
Defined in types.ts:310 @@ -318,7 +318,7 @@
Defined in types.ts:318 @@ -350,7 +350,7 @@
Defined in types.ts:302 @@ -561,6 +561,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/PasswordlessWithEmailOptions.html b/docs/interfaces/PasswordlessWithEmailOptions.html index 806281c2..6b65f5f8 100644 --- a/docs/interfaces/PasswordlessWithEmailOptions.html +++ b/docs/interfaces/PasswordlessWithEmailOptions.html @@ -115,7 +115,7 @@Indexable
Defined in types.ts:340 @@ -196,7 +196,7 @@
Defined in types.ts:352 @@ -225,7 +225,7 @@
Defined in types.ts:344 @@ -258,7 +258,7 @@
Defined in types.ts:348 @@ -455,6 +455,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/PasswordlessWithSMSOptions.html b/docs/interfaces/PasswordlessWithSMSOptions.html index 28048554..aaf7b29f 100644 --- a/docs/interfaces/PasswordlessWithSMSOptions.html +++ b/docs/interfaces/PasswordlessWithSMSOptions.html @@ -115,7 +115,7 @@Indexable
Defined in types.ts:359 @@ -196,7 +196,7 @@
Defined in types.ts:371 @@ -228,7 +228,7 @@
Defined in types.ts:363 @@ -261,7 +261,7 @@
Defined in types.ts:367 @@ -458,6 +458,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/PatchUserOptions.html b/docs/interfaces/PatchUserOptions.html index 24ed76fa..d57791be 100644 --- a/docs/interfaces/PatchUserOptions.html +++ b/docs/interfaces/PatchUserOptions.html @@ -93,7 +93,7 @@Indexable
Defined in types.ts:196 @@ -157,7 +157,7 @@
Defined in types.ts:197 @@ -185,7 +185,7 @@
Defined in types.ts:198 @@ -375,6 +375,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/RefreshTokenOptions.html b/docs/interfaces/RefreshTokenOptions.html index 98353a6a..65d94e17 100644 --- a/docs/interfaces/RefreshTokenOptions.html +++ b/docs/interfaces/RefreshTokenOptions.html @@ -102,7 +102,7 @@Indexable
Defined in types.ts:325 @@ -175,7 +175,7 @@
Defined in types.ts:329 @@ -208,7 +208,7 @@
Defined in types.ts:333 @@ -398,6 +398,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/ResetPasswordOptions.html b/docs/interfaces/ResetPasswordOptions.html index 7a371ccf..ddc7c5cf 100644 --- a/docs/interfaces/ResetPasswordOptions.html +++ b/docs/interfaces/ResetPasswordOptions.html @@ -104,7 +104,7 @@Indexable
Defined in types.ts:522 @@ -177,7 +177,7 @@
Defined in types.ts:530 @@ -206,7 +206,7 @@
Defined in types.ts:526 @@ -396,6 +396,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/RevokeOptions.html b/docs/interfaces/RevokeOptions.html index ca418252..c5c14281 100644 --- a/docs/interfaces/RevokeOptions.html +++ b/docs/interfaces/RevokeOptions.html @@ -95,7 +95,7 @@Indexable
Defined in types.ts:501 @@ -161,7 +161,7 @@
Defined in types.ts:505 @@ -344,6 +344,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/Types.Auth0ContextInterface.html b/docs/interfaces/Types.Auth0ContextInterface.html index 6cbec9ac..37a083da 100644 --- a/docs/interfaces/Types.Auth0ContextInterface.html +++ b/docs/interfaces/Types.Auth0ContextInterface.html @@ -289,31 +289,6 @@Interface Auth0ContextInterface<TUser>
>: boolean;
requireLocalAuthentication: ((title?, - description?, - cancelTitle?, - fallbackTitle?, - strategy?) => Promise<void>);
HierarchyDefined in hooks/auth0-context.ts:20hooks/auth0-context.ts:19 @@ -532,13 +507,6 @@Properties
isLoading - require Local Authentication Defined in hooks/auth0-context.ts:27hooks/auth0-context.ts:26 @@ -820,8 +788,8 @@
Defined in hooks/auth0-context.ts:48hooks/auth0-context.ts:47 @@ -930,8 +898,8 @@
Defined in hooks/auth0-context.ts:60hooks/auth0-context.ts:59 @@ -1039,8 +1007,8 @@
Defined in hooks/auth0-context.ts:66hooks/auth0-context.ts:65 @@ -1150,8 +1118,8 @@
Defined in hooks/auth0-context.ts:72hooks/auth0-context.ts:71 @@ -1259,8 +1227,8 @@
Defined in hooks/auth0-context.ts:38hooks/auth0-context.ts:37 @@ -1331,8 +1299,8 @@
Defined in hooks/auth0-context.ts:108hooks/auth0-context.ts:107 @@ -1462,8 +1430,8 @@
Defined in hooks/auth0-context.ts:86hooks/auth0-context.ts:85 @@ -1499,8 +1467,8 @@
Defined in hooks/auth0-context.ts:130hooks/auth0-context.ts:114 @@ -1681,8 +1649,8 @@
Defined in hooks/auth0-context.ts:99hooks/auth0-context.ts:98 @@ -1783,8 +1751,8 @@
Defined in hooks/auth0-context.ts:80hooks/auth0-context.ts:79 @@ -1824,205 +1792,8 @@
Defined in hooks/auth0-context.ts:138 - - - - -- - - require
-Local Authentication - - require-Local Authentication: - ((title?, - description?, - cancelTitle?, - fallbackTitle?, - strategy?) => Promise<void>) - --Type declaration
--
-- -
--
-- - (title?, - description?, - cancelTitle?, - fallbackTitle?, - strategy?): Promise<void> -
-- -
---- Enables Local Authentication (PIN, Biometric, Swipe - etc) to get the credentials. See - CredentialsManager#requireLocalAuthentication -
---Parameters
--
-- -
--
-Optional
- title: - string --- -- the text to use as title in the authentication - screen. Passing null will result in using the - OS's default value in Android and - "Please authenticate to continue" in - iOS. -
-- -
--
-Optional
- description: string --- -- Android only: the text to use - as description in the authentication screen. On - some Android versions it might not be shown. - Passing null will result in using the OS's - default value. -
-- -
--
-Optional
- cancelTitle: string --- -- iOS only: the cancel message to - display on the local authentication prompt. -
-- -
--
-Optional
- fallbackTitle: string --- -- iOS only: the fallback message - to display on the local authentication prompt - after a failed match. -
-- -
--
-Optional
- strategy: - LocalAuthenticationStrategy --- -- iOS only: the evaluation policy - to use when accessing the credentials. Defaults - to - LocalAuthenticationStrategy.deviceOwnerWithBiometrics. -
-- Returns Promise<void> -
- -- -
@@ -2060,7 +1831,7 @@- - Defined in - hooks/auth0-context.ts:117hooks/auth0-context.ts:122
Type declaration
@@ -2155,7 +1926,7 @@
- (parameters
- Defined in hooks/auth0-context.ts:44hooks/auth0-context.ts:43
Type declaration
@@ -2249,7 +2020,7 @@
- (parameters
- Defined in hooks/auth0-context.ts:54hooks/auth0-context.ts:53
Type declaration
@@ -2346,8 +2117,8 @@
- (parameters
- Defined in hooks/auth0-context.ts:34hooks/auth0-context.ts:33
Defined in hooks/auth0-context.ts:134hooks/auth0-context.ts:118 @@ -2578,13 +2349,6 @@>is
Loading - - require Local Authentication - + + LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/Types.AuthState.html b/docs/interfaces/Types.AuthState.html index d2e45663..748d219c 100644 --- a/docs/interfaces/Types.AuthState.html +++ b/docs/interfaces/Types.AuthState.html @@ -127,8 +127,8 @@Hierarchy
Defined in hooks/auth0-context.ts:126hooks/auth0-context.ts:110 @@ -202,8 +202,8 @@
Defined in hooks/auth0-context.ts:130hooks/auth0-context.ts:114 @@ -237,8 +237,8 @@
Defined in hooks/auth0-context.ts:138hooks/auth0-context.ts:122 @@ -273,8 +273,8 @@
Defined in hooks/auth0-context.ts:134hooks/auth0-context.ts:118 @@ -470,6 +470,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/UserInfoOptions.html b/docs/interfaces/UserInfoOptions.html index 66d56314..c87b9f19 100644 --- a/docs/interfaces/UserInfoOptions.html +++ b/docs/interfaces/UserInfoOptions.html @@ -80,7 +80,7 @@Interface UserInfoOptions
Defined in types.ts:512 @@ -141,7 +141,7 @@
Defined in types.ts:516 @@ -324,6 +324,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/WebAuthorizeOptions.html b/docs/interfaces/WebAuthorizeOptions.html index 7d318565..ad72ee73 100644 --- a/docs/interfaces/WebAuthorizeOptions.html +++ b/docs/interfaces/WebAuthorizeOptions.html @@ -122,7 +122,7 @@Interface WebAuthorizeOptions
Defined in types.ts:110 @@ -222,7 +222,7 @@
Defined in types.ts:124 @@ -261,7 +261,7 @@Default
Defined in types.ts:120 @@ -297,7 +297,7 @@Default
Defined in types.ts:115 @@ -338,7 +338,7 @@
Defined in types.ts:128 @@ -426,7 +426,7 @@Example
Defined in types.ts:146 @@ -637,6 +637,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/interfaces/WebAuthorizeParameters.html b/docs/interfaces/WebAuthorizeParameters.html index a40db5d9..1d53f176 100644 --- a/docs/interfaces/WebAuthorizeParameters.html +++ b/docs/interfaces/WebAuthorizeParameters.html @@ -152,7 +152,7 @@Interface WebAuthorizeParameters
Defined in types.ts:56 @@ -307,7 +307,7 @@
Defined in types.ts:104 @@ -343,7 +343,7 @@
Defined in types.ts:68 @@ -376,7 +376,7 @@
Defined in types.ts:76 @@ -412,7 +412,7 @@
Defined in types.ts:88 @@ -445,7 +445,7 @@
Defined in types.ts:80 @@ -477,7 +477,7 @@
Defined in types.ts:64 @@ -513,7 +513,7 @@
Defined in types.ts:84 @@ -564,7 +564,7 @@
Defined in types.ts:100 @@ -597,7 +597,7 @@
Defined in types.ts:72 @@ -627,7 +627,7 @@
Defined in types.ts:60 @@ -873,6 +873,13 @@>Auth0Provider +
+ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/modules.html b/docs/modules.html index 6bc9ad71..0b486adc 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -76,6 +76,13 @@Namespaces
Enumerations
+ LocalAuthentication Level Interfaces Get User Options + Local Authentication Options Theme >Auth0Provider + + LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/modules/Auth0Provider.html b/docs/modules/Auth0Provider.html index 425faa39..19af44d0 100644 --- a/docs/modules/Auth0Provider.html +++ b/docs/modules/Auth0Provider.html @@ -75,15 +75,15 @@Example
Defined in hooks/auth0-provider.tsx:71 Defined in hooks/auth0-provider.tsx:381hooks/auth0-provider.tsx:363 @@ -260,6 +260,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/modules/Types.html b/docs/modules/Types.html index ac260363..7760dc29 100644 --- a/docs/modules/Types.html +++ b/docs/modules/Types.html @@ -284,6 +284,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/Credentials.html b/docs/types/Credentials.html index f1a23db1..3f9ea471 100644 --- a/docs/types/Credentials.html +++ b/docs/types/Credentials.html @@ -183,7 +183,7 @@
Defined in types.ts:1 @@ -344,6 +344,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/MultifactorChallengeOOBResponse.html b/docs/types/MultifactorChallengeOOBResponse.html index 73fd7b7d..d6e494d0 100644 --- a/docs/types/MultifactorChallengeOOBResponse.html +++ b/docs/types/MultifactorChallengeOOBResponse.html @@ -95,7 +95,7 @@
Defined in types.ts:583 @@ -256,6 +256,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/MultifactorChallengeOOBWithBindingResponse.html b/docs/types/MultifactorChallengeOOBWithBindingResponse.html index a74e2261..08d0a4e1 100644 --- a/docs/types/MultifactorChallengeOOBWithBindingResponse.html +++ b/docs/types/MultifactorChallengeOOBWithBindingResponse.html @@ -97,7 +97,7 @@
Defined in types.ts:587 @@ -258,6 +258,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/MultifactorChallengeOTPResponse.html b/docs/types/MultifactorChallengeOTPResponse.html index a2abf269..0488aff7 100644 --- a/docs/types/MultifactorChallengeOTPResponse.html +++ b/docs/types/MultifactorChallengeOTPResponse.html @@ -90,7 +90,7 @@
Defined in types.ts:581 @@ -251,6 +251,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/MultifactorChallengeResponse.html b/docs/types/MultifactorChallengeResponse.html index 8ae003bb..c1d35744 100644 --- a/docs/types/MultifactorChallengeResponse.html +++ b/docs/types/MultifactorChallengeResponse.html @@ -85,7 +85,7 @@Type alias MultifactorChallengeResponse
Defined in types.ts:592 @@ -246,6 +246,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/Types.Auth0Response.html b/docs/types/Types.Auth0Response.html index 9bc2e536..52bb1e49 100644 --- a/docs/types/Types.Auth0Response.html +++ b/docs/types/Types.Auth0Response.html @@ -147,7 +147,7 @@
Defined in networking/index.ts:134 @@ -308,6 +308,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/Types.Telemetry.html b/docs/types/Types.Telemetry.html index 28e54b0a..29c97bb2 100644 --- a/docs/types/Types.Telemetry.html +++ b/docs/types/Types.Telemetry.html @@ -111,7 +111,7 @@
Defined in networking/telemetry.ts:3 @@ -272,6 +272,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/types/User.html b/docs/types/User.html index cb4ed0a3..24df67be 100644 --- a/docs/types/User.html +++ b/docs/types/User.html @@ -330,7 +330,7 @@
Defined in types.ts:29 @@ -491,6 +491,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/docs/variables/Auth0Provider.propTypes.html b/docs/variables/Auth0Provider.propTypes.html index 5e800a5c..76846ec9 100644 --- a/docs/variables/Auth0Provider.propTypes.html +++ b/docs/variables/Auth0Provider.propTypes.html @@ -126,8 +126,8 @@
Defined in hooks/auth0-provider.tsx:381hooks/auth0-provider.tsx:363 @@ -287,6 +287,13 @@Theme
>Auth0Provider ++ LocalAuthenticationLevel + + + LocalAuthenticationOptions + - - MultifactorChallengeOptions - -- PasswordRealmOptions - Loading... diff --git a/package-lock.json b/package-lock.json index c5aff4aa..7432dde3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "react-native-auth0", - "version": "3.2.1", + "version": "4.0.0-beta.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "react-native-auth0", - "version": "3.2.1", + "version": "4.0.0-beta.0", "license": "MIT", "dependencies": { "base-64": "^0.1.0", diff --git a/package.json b/package.json index 2d06c04f..2db4f8cd 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "react-native-auth0", "title": "React Native Auth0", - "version": "3.2.1", + "version": "4.0.0-beta.0", "description": "React Native toolkit for Auth0 API", "main": "lib/commonjs/index", "module": "lib/module/index",
- Enables Local Authentication (PIN, Biometric, Swipe etc) to - get the credentials -
-