From b983be993fea12e79a9c9ce4dd1b6146691fe5eb Mon Sep 17 00:00:00 2001 From: Chetan Sharma Date: Fri, 3 Jul 2026 15:59:49 +0530 Subject: [PATCH] Release v2.10.0 --- .version | 2 +- CHANGELOG.md | 6 + docs/assets/hierarchy.js | 3 +- docs/assets/highlight.css | 157 +- docs/assets/icons.js | 37 +- docs/assets/icons.svg | 2 +- docs/assets/main.js | 2546 +------------ docs/assets/navigation.js | 3 +- docs/assets/search.js | 3 +- docs/assets/style.css | 3147 +++++++++-------- docs/classes/AbstractNavigator.html | 563 +-- docs/classes/Auth0ClientFactory.html | 521 +-- docs/classes/AuthClientConfig.html | 660 +--- docs/classes/AuthGuard.html | 766 +--- docs/classes/AuthHttpInterceptor.html | 653 +--- docs/classes/AuthModule.html | 538 +-- docs/classes/AuthService.html | 2961 +--------------- docs/classes/AuthState.html | 1147 +----- docs/classes/AuthenticationError.html | 1378 +------- docs/classes/ConnectError.html | 1432 +------- docs/classes/Fetcher.html | 2139 +---------- docs/classes/GenericError.html | 1247 +------ docs/classes/InMemoryCache.html | 477 +-- docs/classes/LocalStorageCache.html | 839 +---- docs/classes/MfaChallengeError.html | 1274 +------ docs/classes/MfaEnrollmentError.html | 1274 +------ docs/classes/MfaEnrollmentFactorsError.html | 1278 +------ docs/classes/MfaError.html | 1290 +------ docs/classes/MfaListAuthenticatorsError.html | 1278 +------ docs/classes/MfaRequiredError.html | 1381 +------- docs/classes/MfaVerifyError.html | 1270 +------ docs/classes/MissingRefreshTokenError.html | 1347 +------ docs/classes/MyAccountApiError.html | 46 + docs/classes/PasskeyChallengeError.html | 35 + docs/classes/PasskeyError.html | 34 + docs/classes/PasskeyGetTokenError.html | 37 + docs/classes/PasskeyRegisterError.html | 35 + docs/classes/PopupCancelledError.html | 1288 +------ docs/classes/PopupOpenError.html | 1233 +------ docs/classes/PopupTimeoutError.html | 1291 +------ docs/classes/TimeoutError.html | 1245 +------ docs/classes/UseDpopNonceError.html | 1304 +------ docs/classes/User.html | 1312 +------ docs/enums/HttpMethod.html | 595 +--- docs/enums/ResponseType.html | 428 +-- docs/functions/authGuardFn.html | 340 +- docs/functions/authHttpInterceptorFn.html | 380 +- .../isHttpInterceptorRouteConfig.html | 326 +- docs/functions/provideAuth0.html | 338 +- docs/hierarchy.html | 466 +-- docs/index.html | 852 +---- docs/interfaces/AppState.html | 563 +-- docs/interfaces/AuthConfig.html | 2409 +------------ docs/interfaces/Authenticator.html | 708 +--- docs/interfaces/AuthorizationParams.html | 1359 +------ .../ChallengeAuthenticatorParams.html | 508 +-- docs/interfaces/ChallengeResponse.html | 504 +-- .../interfaces/EmailAuthenticationMethod.html | 9 + .../EmailEnrollmentChallengeOptions.html | 3 + .../EmailEnrollmentChallengeResponse.html | 5 + .../EmailEnrollmentVerifyOptions.html | 5 + docs/interfaces/EnrollEmailParams.html | 512 +-- docs/interfaces/EnrollOtpParams.html | 460 +-- docs/interfaces/EnrollPushParams.html | 460 +-- docs/interfaces/EnrollSmsParams.html | 515 +-- docs/interfaces/EnrollVoiceParams.html | 515 +-- docs/interfaces/EnrollmentFactor.html | 386 +- docs/interfaces/Factor.html | 3 + docs/interfaces/GetTokenSilentlyOptions.html | 718 +--- docs/interfaces/GetTokenWithPopupOptions.html | 502 +-- docs/interfaces/HttpInterceptorConfig.html | 399 +-- .../HttpInterceptorRouteConfig.html | 722 +--- docs/interfaces/ICache.html | 818 +---- docs/interfaces/IdToken.html | 2196 +----------- docs/interfaces/LogoutOptions.html | 740 +--- docs/interfaces/MyAccountApiClient.html | 46 + docs/interfaces/ObservableMfaApiClient.html | 1057 +----- .../ObservableMyAccountApiClient.html | 21 + .../ObservablePasskeyApiClient.html | 11 + docs/interfaces/OobEnrollmentResponse.html | 724 +--- docs/interfaces/OtpEnrollmentResponse.html | 605 +--- docs/interfaces/PasskeyApiClient.html | 32 + .../PasskeyAuthenticationMethod.html | 16 + docs/interfaces/PasskeyCreationOptions.html | 8 + .../interfaces/PasskeyCredentialResponse.html | 9 + .../PasskeyEnrollmentChallengeOptions.html | 4 + .../PasskeyEnrollmentChallengeResponse.html | 6 + .../PasskeyEnrollmentVerifyOptions.html | 5 + docs/interfaces/PasskeyErrorResponse.html | 4 + .../PasskeyLoginChallengeOptions.html | 6 + .../PasskeyLoginChallengeResponse.html | 4 + docs/interfaces/PasskeyRequestOptions.html | 6 + .../PasskeySignupChallengeResponse.html | 4 + .../PasswordAuthenticationMethod.html | 7 + .../PasswordEnrollmentChallengeOptions.html | 4 + .../PasswordEnrollmentChallengeResponse.html | 6 + .../PasswordEnrollmentVerifyOptions.html | 5 + .../interfaces/PhoneAuthenticationMethod.html | 10 + .../PhoneEnrollmentChallengeOptions.html | 4 + .../PhoneEnrollmentChallengeResponse.html | 5 + .../PhoneEnrollmentVerifyOptions.html | 5 + docs/interfaces/PopupConfigOptions.html | 551 +-- docs/interfaces/PopupLoginOptions.html | 429 +-- .../PushNotificationAuthenticationMethod.html | 8 + ...otificationEnrollmentChallengeOptions.html | 2 + ...tificationEnrollmentChallengeResponse.html | 7 + ...shNotificationEnrollmentVerifyOptions.html | 4 + .../RecoveryCodeAuthenticationMethod.html | 7 + ...ecoveryCodeEnrollmentChallengeOptions.html | 2 + ...coveryCodeEnrollmentChallengeResponse.html | 6 + .../RecoveryCodeEnrollmentVerifyOptions.html | 4 + .../RedirectConnectAccountOptions.html | 781 +--- docs/interfaces/RedirectLoginOptions.html | 688 +--- docs/interfaces/TotpAuthenticationMethod.html | 8 + .../TotpEnrollmentChallengeOptions.html | 2 + .../TotpEnrollmentChallengeResponse.html | 7 + .../TotpEnrollmentVerifyOptions.html | 5 + .../UpdateAuthenticationMethodRequest.html | 4 + docs/interfaces/VerifyParams.html | 621 +--- .../WebAuthnPlatformAuthenticationMethod.html | 10 + .../WebAuthnRoamingAuthenticationMethod.html | 10 + docs/modules.html | 2643 +------------- docs/types/ApiRouteDefinition.html | 272 +- docs/types/AuthenticationMethod.html | 1 + docs/types/AuthenticationMethodType.html | 1 + docs/types/AuthenticatorType.html | 263 +- docs/types/Cacheable.html | 253 +- docs/types/ConnectAccountRedirectResult.html | 359 +- docs/types/ConnectedAccount.html | 271 +- docs/types/CustomFetchMinimalOutput.html | 429 +-- docs/types/CustomTokenExchangeOptions.html | 868 +---- docs/types/EnrollParams.html | 282 +- docs/types/EnrollmentChallengeOptions.html | 1 + docs/types/EnrollmentChallengeResponse.html | 1 + docs/types/EnrollmentResponse.html | 265 +- docs/types/EnrollmentVerifyOptions.html | 1 + docs/types/FetcherConfig.html | 566 +-- docs/types/InteractiveErrorHandler.html | 264 +- docs/types/MfaFactorType.html | 263 +- docs/types/MfaGrantType.html | 264 +- docs/types/OobChannel.html | 265 +- docs/types/PasskeyLoginOptions.html | 2 + docs/types/PasskeySignupChallengeOptions.html | 4 + docs/types/PasskeySignupOptions.html | 2 + docs/types/TokenEndpointResponse.html | 627 +--- docs/variables/Auth0ClientService.html | 258 +- docs/variables/AuthConfigService.html | 286 +- projects/auth0-angular/package.json | 2 +- 148 files changed, 3848 insertions(+), 68858 deletions(-) create mode 100644 docs/classes/MyAccountApiError.html create mode 100644 docs/classes/PasskeyChallengeError.html create mode 100644 docs/classes/PasskeyError.html create mode 100644 docs/classes/PasskeyGetTokenError.html create mode 100644 docs/classes/PasskeyRegisterError.html create mode 100644 docs/interfaces/EmailAuthenticationMethod.html create mode 100644 docs/interfaces/EmailEnrollmentChallengeOptions.html create mode 100644 docs/interfaces/EmailEnrollmentChallengeResponse.html create mode 100644 docs/interfaces/EmailEnrollmentVerifyOptions.html create mode 100644 docs/interfaces/Factor.html create mode 100644 docs/interfaces/MyAccountApiClient.html create mode 100644 docs/interfaces/ObservableMyAccountApiClient.html create mode 100644 docs/interfaces/ObservablePasskeyApiClient.html create mode 100644 docs/interfaces/PasskeyApiClient.html create mode 100644 docs/interfaces/PasskeyAuthenticationMethod.html create mode 100644 docs/interfaces/PasskeyCreationOptions.html create mode 100644 docs/interfaces/PasskeyCredentialResponse.html create mode 100644 docs/interfaces/PasskeyEnrollmentChallengeOptions.html create mode 100644 docs/interfaces/PasskeyEnrollmentChallengeResponse.html create mode 100644 docs/interfaces/PasskeyEnrollmentVerifyOptions.html create mode 100644 docs/interfaces/PasskeyErrorResponse.html create mode 100644 docs/interfaces/PasskeyLoginChallengeOptions.html create mode 100644 docs/interfaces/PasskeyLoginChallengeResponse.html create mode 100644 docs/interfaces/PasskeyRequestOptions.html create mode 100644 docs/interfaces/PasskeySignupChallengeResponse.html create mode 100644 docs/interfaces/PasswordAuthenticationMethod.html create mode 100644 docs/interfaces/PasswordEnrollmentChallengeOptions.html create mode 100644 docs/interfaces/PasswordEnrollmentChallengeResponse.html create mode 100644 docs/interfaces/PasswordEnrollmentVerifyOptions.html create mode 100644 docs/interfaces/PhoneAuthenticationMethod.html create mode 100644 docs/interfaces/PhoneEnrollmentChallengeOptions.html create mode 100644 docs/interfaces/PhoneEnrollmentChallengeResponse.html create mode 100644 docs/interfaces/PhoneEnrollmentVerifyOptions.html create mode 100644 docs/interfaces/PushNotificationAuthenticationMethod.html create mode 100644 docs/interfaces/PushNotificationEnrollmentChallengeOptions.html create mode 100644 docs/interfaces/PushNotificationEnrollmentChallengeResponse.html create mode 100644 docs/interfaces/PushNotificationEnrollmentVerifyOptions.html create mode 100644 docs/interfaces/RecoveryCodeAuthenticationMethod.html create mode 100644 docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html create mode 100644 docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html create mode 100644 docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html create mode 100644 docs/interfaces/TotpAuthenticationMethod.html create mode 100644 docs/interfaces/TotpEnrollmentChallengeOptions.html create mode 100644 docs/interfaces/TotpEnrollmentChallengeResponse.html create mode 100644 docs/interfaces/TotpEnrollmentVerifyOptions.html create mode 100644 docs/interfaces/UpdateAuthenticationMethodRequest.html create mode 100644 docs/interfaces/WebAuthnPlatformAuthenticationMethod.html create mode 100644 docs/interfaces/WebAuthnRoamingAuthenticationMethod.html create mode 100644 docs/types/AuthenticationMethod.html create mode 100644 docs/types/AuthenticationMethodType.html create mode 100644 docs/types/EnrollmentChallengeOptions.html create mode 100644 docs/types/EnrollmentChallengeResponse.html create mode 100644 docs/types/EnrollmentVerifyOptions.html create mode 100644 docs/types/PasskeyLoginOptions.html create mode 100644 docs/types/PasskeySignupChallengeOptions.html create mode 100644 docs/types/PasskeySignupOptions.html diff --git a/.version b/.version index ed51b084..1f38bc0e 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.9.0 \ No newline at end of file +v2.10.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 23abc1cb..ec0af3c9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.10.0](https://github.com/auth0/auth0-angular/tree/v2.10.0) (2026-07-03) +[Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.9.0...v2.10.0) + +**Added** +- feat: add Passkey and MyAccount API support [\#927](https://github.com/auth0/auth0-angular/pull/927) ([cschetan77](https://github.com/cschetan77)) + ## [v2.9.0](https://github.com/auth0/auth0-angular/tree/v2.9.0) (2026-04-28) [Full Changelog](https://github.com/auth0/auth0-angular/compare/v2.8.1...v2.9.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index db7f838a..02e4faab 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1,2 +1 @@ -window.hierarchyData = - 'eJyVlF9v2yAUxb8Lz3SNbYyN36Z0myal69R120PVB0SuY1QCHpCHqcp3n5xoLbaTQp4iOef6d8794xdkjfEONY+ElrigOS5y+oSRhVaB8NJoh5oXVOR0+NF8C6hB302/61dmI/Vdf5Rg9Cz1GjV5STHaWYUaJLUH23IB7nqm/9D5rUIYCcWdQw3ybn01vODqtWj4s5NqbUGj5rEo8qc9RkWRBy6+gH8wz6B/S98dCGlmzpUleBos0NDC1yUXHUSAR9HFkav6ELmqA97KCK5+eGP5BsboLK//ow8EcNcz8VkLxwd7jAgtRw3WYKX4ZK2x74FCXYQxikjYApdZgUta4ZItMM0YpoRgWmW4qgiuMza0gLBFYOpBbsHsfNRUqLvEVEkOq1ZmRQC9bfk9/NlJC+soeKqNd70k+fS4UlPOxAk0Wk1pdz3oNNSrMoEzGtvHne9Aeyn4cGxR2Al5nEgzNk225FqAUgljOyFPIBISbol0TurNPbQWXHf4yMS35UxNArvKAvbSaA0ivjChLs6oqjDfTwc3vem/GS0gCpqJ47R6NL/blqfc2sUHXhOCa8pwzQhmGcOMkOHg6/EoW76SzgdraKxLsXOmKiE8nYbX1ii1BR0f6lydwGOTvMuOKwV6Ex/tTBynselof4GV7d8UVKBM4Eyn+NaXz1ykDvF0UYy+3/8Dnj4VfQ=='; +window.hierarchyData = "eJyVlF9v2yAUxb8Lz3RltjHGb1X2R5PSdeq67aHqAyI3MSoBD8jDVOW7T060DttJIU+W7HP9O+deLi/IWRs8ah8r3uCSl7ik7AkjB2sNMihrPGpfUEnZ8DBiC6hF32y/65d2o8xdf5Rg9KzMCrUFrTHaOY1apEwAtxYS/PVM/64LW40wklp4j1oU/Opq+MHVa9HwsVN65cCg9rGsy6c9RmVdRi4+Q3iwz2B+qdAdCHlmzpVleBos8NjCl4WQHSSAR9GlkSvCh8gV4RFvaaXQ34N1YgNj9Pui+Yc+EMBfz8RnLRxfDDTejBpswCn50Tnr3gLFugRjFJEWJaZVjWtCcF2UuKYFrhnDjFS4IQw3tBpaQIu45Q9qC3YXkqZi3UWmGD1AqzqC3q7FPfzeKQerJHiqTXedMjpdrtyUM3GaVhMypd31YPJQr8oMzmhsN7vQgQlKimHZkrAT8gwiLabJFsJI0DpjbCfkGUQWX4u3yntlNvewduC7wyWTPi1natJsRqqIvbDGgEwfmFiXZjQkzvfDw4fe9l+tkZAEzcQZNFqNdy5n1y5e8IZxzEmFecExpxXm7HDRNoyP4UvlQ3QMrfM5ds5UpcNzMg1vnNV6CyY91Lk6g1dM8i46oTWYTXq0M3EGbTran+DU+k8OKlJmcKZT/N+XT0LmDvF0UYq+3/8FJaEViw==" \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 1f25b047..4458137b 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,32 +1,31 @@ :root { - --light-hl-0: #795e26; - --dark-hl-0: #dcdcaa; - --light-hl-1: #000000; - --dark-hl-1: #d4d4d4; - --light-hl-2: #a31515; - --dark-hl-2: #ce9178; - --light-hl-3: #af00db; - --dark-hl-3: #c586c0; - --light-hl-4: #001080; - --dark-hl-4: #9cdcfe; - --light-hl-5: #0000ff; - --dark-hl-5: #569cd6; - --light-hl-6: #0070c1; - --dark-hl-6: #4fc1ff; - --light-hl-7: #267f99; - --dark-hl-7: #4ec9b0; - --light-hl-8: #008000; - --dark-hl-8: #6a9955; - --light-hl-9: #000000; - --dark-hl-9: #c8c8c8; - --light-hl-10: #098658; - --dark-hl-10: #b5cea8; - --light-code-background: #ffffff; - --dark-code-background: #1e1e1e; + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #267F99; + --dark-hl-7: #4EC9B0; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; + --light-hl-9: #000000; + --dark-hl-9: #C8C8C8; + --light-hl-10: #098658; + --dark-hl-10: #B5CEA8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; } -@media (prefers-color-scheme: light) { - :root { +@media (prefers-color-scheme: light) { :root { --hl-0: var(--light-hl-0); --hl-1: var(--light-hl-1); --hl-2: var(--light-hl-2); @@ -39,11 +38,9 @@ --hl-9: var(--light-hl-9); --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); - } -} +} } -@media (prefers-color-scheme: dark) { - :root { +@media (prefers-color-scheme: dark) { :root { --hl-0: var(--dark-hl-0); --hl-1: var(--dark-hl-1); --hl-2: var(--dark-hl-2); @@ -56,73 +53,47 @@ --hl-9: var(--dark-hl-9); --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); - } -} +} } :root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --code-background: var(--light-code-background); + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); } :root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --code-background: var(--dark-code-background); + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); } -.hl-0 { - color: var(--hl-0); -} -.hl-1 { - color: var(--hl-1); -} -.hl-2 { - color: var(--hl-2); -} -.hl-3 { - color: var(--hl-3); -} -.hl-4 { - color: var(--hl-4); -} -.hl-5 { - color: var(--hl-5); -} -.hl-6 { - color: var(--hl-6); -} -.hl-7 { - color: var(--hl-7); -} -.hl-8 { - color: var(--hl-8); -} -.hl-9 { - color: var(--hl-9); -} -.hl-10 { - color: var(--hl-10); -} -pre, -code { - background: var(--code-background); -} +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js index b5b93f25..4fbadc5a 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -1,21 +1,18 @@ -(function () { - addIcons(); - function addIcons() { - if (document.readyState === 'loading') - return document.addEventListener('DOMContentLoaded', addIcons); - const svg = document.body.appendChild( - document.createElementNS('http://www.w3.org/2000/svg', 'svg') - ); - svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; - svg.style.display = 'none'; - if (location.protocol === 'file:') updateUseElements(); - } +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } - function updateUseElements() { - document.querySelectorAll('use').forEach((el) => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } -})(); + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 10db10be..be7798fc 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 32295a81..8182ceec 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,2543 +1,9 @@ -'use strict'; -window.translations = { - copy: 'Copy', - copied: 'Copied!', - normally_hidden: - 'This member is normally hidden due to your filter settings.', - hierarchy_expand: 'Expand', - hierarchy_collapse: 'Collapse', - folder: 'Folder', - search_index_not_available: 'The search index is not available', - search_no_results_found_for_0: 'No results found for {0}', - kind_1: 'Project', - kind_2: 'Module', - kind_4: 'Namespace', - kind_8: 'Enumeration', - kind_16: 'Enumeration Member', - kind_32: 'Variable', - kind_64: 'Function', - kind_128: 'Class', - kind_256: 'Interface', - kind_512: 'Constructor', - kind_1024: 'Property', - kind_2048: 'Method', - kind_4096: 'Call Signature', - kind_8192: 'Index Signature', - kind_16384: 'Constructor Signature', - kind_32768: 'Parameter', - kind_65536: 'Type Literal', - kind_131072: 'Type Parameter', - kind_262144: 'Accessor', - kind_524288: 'Get Signature', - kind_1048576: 'Set Signature', - kind_2097152: 'Type Alias', - kind_4194304: 'Reference', - kind_8388608: 'Document', -}; -('use strict'); -(() => { - var Ke = Object.create; - var he = Object.defineProperty; - var Ge = Object.getOwnPropertyDescriptor; - var Ze = Object.getOwnPropertyNames; - var Xe = Object.getPrototypeOf, - Ye = Object.prototype.hasOwnProperty; - var et = (t, e) => () => ( - e || t((e = { exports: {} }).exports, e), e.exports - ); - var tt = (t, e, n, r) => { - if ((e && typeof e == 'object') || typeof e == 'function') - for (let i of Ze(e)) - !Ye.call(t, i) && - i !== n && - he(t, i, { - get: () => e[i], - enumerable: !(r = Ge(e, i)) || r.enumerable, - }); - return t; - }; - var nt = (t, e, n) => ( - (n = t != null ? Ke(Xe(t)) : {}), - tt( - e || !t || !t.__esModule - ? he(n, 'default', { value: t, enumerable: !0 }) - : n, - t - ) - ); - var ye = et((me, ge) => { - (function () { - var t = function (e) { - var n = new t.Builder(); - return ( - n.pipeline.add(t.trimmer, t.stopWordFilter, t.stemmer), - n.searchPipeline.add(t.stemmer), - e.call(n, n), - n.build() - ); - }; - t.version = '2.3.9'; - (t.utils = {}), - (t.utils.warn = (function (e) { - return function (n) { - e.console && console.warn && console.warn(n); - }; - })(this)), - (t.utils.asString = function (e) { - return e == null ? '' : e.toString(); - }), - (t.utils.clone = function (e) { - if (e == null) return e; - for ( - var n = Object.create(null), r = Object.keys(e), i = 0; - i < r.length; - i++ - ) { - var s = r[i], - o = e[s]; - if (Array.isArray(o)) { - n[s] = o.slice(); - continue; - } - if ( - typeof o == 'string' || - typeof o == 'number' || - typeof o == 'boolean' - ) { - n[s] = o; - continue; - } - throw new TypeError( - 'clone is not deep and does not support nested objects' - ); - } - return n; - }), - (t.FieldRef = function (e, n, r) { - (this.docRef = e), (this.fieldName = n), (this._stringValue = r); - }), - (t.FieldRef.joiner = '/'), - (t.FieldRef.fromString = function (e) { - var n = e.indexOf(t.FieldRef.joiner); - if (n === -1) throw 'malformed field ref string'; - var r = e.slice(0, n), - i = e.slice(n + 1); - return new t.FieldRef(i, r, e); - }), - (t.FieldRef.prototype.toString = function () { - return ( - this._stringValue == null && - (this._stringValue = - this.fieldName + t.FieldRef.joiner + this.docRef), - this._stringValue - ); - }); - (t.Set = function (e) { - if (((this.elements = Object.create(null)), e)) { - this.length = e.length; - for (var n = 0; n < this.length; n++) this.elements[e[n]] = !0; - } else this.length = 0; - }), - (t.Set.complete = { - intersect: function (e) { - return e; - }, - union: function () { - return this; - }, - contains: function () { - return !0; - }, - }), - (t.Set.empty = { - intersect: function () { - return this; - }, - union: function (e) { - return e; - }, - contains: function () { - return !1; - }, - }), - (t.Set.prototype.contains = function (e) { - return !!this.elements[e]; - }), - (t.Set.prototype.intersect = function (e) { - var n, - r, - i, - s = []; - if (e === t.Set.complete) return this; - if (e === t.Set.empty) return e; - this.length < e.length - ? ((n = this), (r = e)) - : ((n = e), (r = this)), - (i = Object.keys(n.elements)); - for (var o = 0; o < i.length; o++) { - var a = i[o]; - a in r.elements && s.push(a); - } - return new t.Set(s); - }), - (t.Set.prototype.union = function (e) { - return e === t.Set.complete - ? t.Set.complete - : e === t.Set.empty - ? this - : new t.Set( - Object.keys(this.elements).concat(Object.keys(e.elements)) - ); - }), - (t.idf = function (e, n) { - var r = 0; - for (var i in e) i != '_index' && (r += Object.keys(e[i]).length); - var s = (n - r + 0.5) / (r + 0.5); - return Math.log(1 + Math.abs(s)); - }), - (t.Token = function (e, n) { - (this.str = e || ''), (this.metadata = n || {}); - }), - (t.Token.prototype.toString = function () { - return this.str; - }), - (t.Token.prototype.update = function (e) { - return (this.str = e(this.str, this.metadata)), this; - }), - (t.Token.prototype.clone = function (e) { - return ( - (e = - e || - function (n) { - return n; - }), - new t.Token(e(this.str, this.metadata), this.metadata) - ); - }); - (t.tokenizer = function (e, n) { - if (e == null || e == null) return []; - if (Array.isArray(e)) - return e.map(function (f) { - return new t.Token( - t.utils.asString(f).toLowerCase(), - t.utils.clone(n) - ); - }); - for ( - var r = e.toString().toLowerCase(), - i = r.length, - s = [], - o = 0, - a = 0; - o <= i; - o++ - ) { - var c = r.charAt(o), - l = o - a; - if (c.match(t.tokenizer.separator) || o == i) { - if (l > 0) { - var d = t.utils.clone(n) || {}; - (d.position = [a, l]), - (d.index = s.length), - s.push(new t.Token(r.slice(a, o), d)); - } - a = o + 1; - } - } - return s; - }), - (t.tokenizer.separator = /[\s\-]+/); - (t.Pipeline = function () { - this._stack = []; - }), - (t.Pipeline.registeredFunctions = Object.create(null)), - (t.Pipeline.registerFunction = function (e, n) { - n in this.registeredFunctions && - t.utils.warn('Overwriting existing registered function: ' + n), - (e.label = n), - (t.Pipeline.registeredFunctions[e.label] = e); - }), - (t.Pipeline.warnIfFunctionNotRegistered = function (e) { - var n = e.label && e.label in this.registeredFunctions; - n || - t.utils.warn( - `Function is not registered with pipeline. This may cause problems when serialising the index. -`, - e - ); - }), - (t.Pipeline.load = function (e) { - var n = new t.Pipeline(); - return ( - e.forEach(function (r) { - var i = t.Pipeline.registeredFunctions[r]; - if (i) n.add(i); - else throw new Error('Cannot load unregistered function: ' + r); - }), - n - ); - }), - (t.Pipeline.prototype.add = function () { - var e = Array.prototype.slice.call(arguments); - e.forEach(function (n) { - t.Pipeline.warnIfFunctionNotRegistered(n), this._stack.push(n); - }, this); - }), - (t.Pipeline.prototype.after = function (e, n) { - t.Pipeline.warnIfFunctionNotRegistered(n); - var r = this._stack.indexOf(e); - if (r == -1) throw new Error('Cannot find existingFn'); - (r = r + 1), this._stack.splice(r, 0, n); - }), - (t.Pipeline.prototype.before = function (e, n) { - t.Pipeline.warnIfFunctionNotRegistered(n); - var r = this._stack.indexOf(e); - if (r == -1) throw new Error('Cannot find existingFn'); - this._stack.splice(r, 0, n); - }), - (t.Pipeline.prototype.remove = function (e) { - var n = this._stack.indexOf(e); - n != -1 && this._stack.splice(n, 1); - }), - (t.Pipeline.prototype.run = function (e) { - for (var n = this._stack.length, r = 0; r < n; r++) { - for (var i = this._stack[r], s = [], o = 0; o < e.length; o++) { - var a = i(e[o], o, e); - if (!(a == null || a === '')) - if (Array.isArray(a)) - for (var c = 0; c < a.length; c++) s.push(a[c]); - else s.push(a); - } - e = s; - } - return e; - }), - (t.Pipeline.prototype.runString = function (e, n) { - var r = new t.Token(e, n); - return this.run([r]).map(function (i) { - return i.toString(); - }); - }), - (t.Pipeline.prototype.reset = function () { - this._stack = []; - }), - (t.Pipeline.prototype.toJSON = function () { - return this._stack.map(function (e) { - return t.Pipeline.warnIfFunctionNotRegistered(e), e.label; - }); - }); - (t.Vector = function (e) { - (this._magnitude = 0), (this.elements = e || []); - }), - (t.Vector.prototype.positionForIndex = function (e) { - if (this.elements.length == 0) return 0; - for ( - var n = 0, - r = this.elements.length / 2, - i = r - n, - s = Math.floor(i / 2), - o = this.elements[s * 2]; - i > 1 && (o < e && (n = s), o > e && (r = s), o != e); - - ) - (i = r - n), - (s = n + Math.floor(i / 2)), - (o = this.elements[s * 2]); - if (o == e || o > e) return s * 2; - if (o < e) return (s + 1) * 2; - }), - (t.Vector.prototype.insert = function (e, n) { - this.upsert(e, n, function () { - throw 'duplicate index'; - }); - }), - (t.Vector.prototype.upsert = function (e, n, r) { - this._magnitude = 0; - var i = this.positionForIndex(e); - this.elements[i] == e - ? (this.elements[i + 1] = r(this.elements[i + 1], n)) - : this.elements.splice(i, 0, e, n); - }), - (t.Vector.prototype.magnitude = function () { - if (this._magnitude) return this._magnitude; - for (var e = 0, n = this.elements.length, r = 1; r < n; r += 2) { - var i = this.elements[r]; - e += i * i; - } - return (this._magnitude = Math.sqrt(e)); - }), - (t.Vector.prototype.dot = function (e) { - for ( - var n = 0, - r = this.elements, - i = e.elements, - s = r.length, - o = i.length, - a = 0, - c = 0, - l = 0, - d = 0; - l < s && d < o; - - ) - (a = r[l]), - (c = i[d]), - a < c - ? (l += 2) - : a > c - ? (d += 2) - : a == c && ((n += r[l + 1] * i[d + 1]), (l += 2), (d += 2)); - return n; - }), - (t.Vector.prototype.similarity = function (e) { - return this.dot(e) / this.magnitude() || 0; - }), - (t.Vector.prototype.toArray = function () { - for ( - var e = new Array(this.elements.length / 2), n = 1, r = 0; - n < this.elements.length; - n += 2, r++ - ) - e[r] = this.elements[n]; - return e; - }), - (t.Vector.prototype.toJSON = function () { - return this.elements; - }); - (t.stemmer = (function () { - var e = { - ational: 'ate', - tional: 'tion', - enci: 'ence', - anci: 'ance', - izer: 'ize', - bli: 'ble', - alli: 'al', - entli: 'ent', - eli: 'e', - ousli: 'ous', - ization: 'ize', - ation: 'ate', - ator: 'ate', - alism: 'al', - iveness: 'ive', - fulness: 'ful', - ousness: 'ous', - aliti: 'al', - iviti: 'ive', - biliti: 'ble', - logi: 'log', - }, - n = { - icate: 'ic', - ative: '', - alize: 'al', - iciti: 'ic', - ical: 'ic', - ful: '', - ness: '', - }, - r = '[^aeiou]', - i = '[aeiouy]', - s = r + '[^aeiouy]*', - o = i + '[aeiou]*', - a = '^(' + s + ')?' + o + s, - c = '^(' + s + ')?' + o + s + '(' + o + ')?$', - l = '^(' + s + ')?' + o + s + o + s, - d = '^(' + s + ')?' + i, - f = new RegExp(a), - p = new RegExp(l), - v = new RegExp(c), - x = new RegExp(d), - w = /^(.+?)(ss|i)es$/, - m = /^(.+?)([^s])s$/, - g = /^(.+?)eed$/, - T = /^(.+?)(ed|ing)$/, - L = /.$/, - C = /(at|bl|iz)$/, - O = new RegExp('([^aeiouylsz])\\1$'), - j = new RegExp('^' + s + i + '[^aeiouwxy]$'), - N = /^(.+?[^aeiou])y$/, - q = - /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/, - W = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/, - B = - /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/, - z = /^(.+?)(s|t)(ion)$/, - _ = /^(.+?)e$/, - U = /ll$/, - J = new RegExp('^' + s + i + '[^aeiouwxy]$'), - V = function (u) { - var y, P, k, h, E, Q, H; - if (u.length < 3) return u; - if ( - ((k = u.substr(0, 1)), - k == 'y' && (u = k.toUpperCase() + u.substr(1)), - (h = w), - (E = m), - h.test(u) - ? (u = u.replace(h, '$1$2')) - : E.test(u) && (u = u.replace(E, '$1$2')), - (h = g), - (E = T), - h.test(u)) - ) { - var b = h.exec(u); - (h = f), h.test(b[1]) && ((h = L), (u = u.replace(h, ''))); - } else if (E.test(u)) { - var b = E.exec(u); - (y = b[1]), - (E = x), - E.test(y) && - ((u = y), - (E = C), - (Q = O), - (H = j), - E.test(u) - ? (u = u + 'e') - : Q.test(u) - ? ((h = L), (u = u.replace(h, ''))) - : H.test(u) && (u = u + 'e')); - } - if (((h = N), h.test(u))) { - var b = h.exec(u); - (y = b[1]), (u = y + 'i'); - } - if (((h = q), h.test(u))) { - var b = h.exec(u); - (y = b[1]), (P = b[2]), (h = f), h.test(y) && (u = y + e[P]); - } - if (((h = W), h.test(u))) { - var b = h.exec(u); - (y = b[1]), (P = b[2]), (h = f), h.test(y) && (u = y + n[P]); - } - if (((h = B), (E = z), h.test(u))) { - var b = h.exec(u); - (y = b[1]), (h = p), h.test(y) && (u = y); - } else if (E.test(u)) { - var b = E.exec(u); - (y = b[1] + b[2]), (E = p), E.test(y) && (u = y); - } - if (((h = _), h.test(u))) { - var b = h.exec(u); - (y = b[1]), - (h = p), - (E = v), - (Q = J), - (h.test(y) || (E.test(y) && !Q.test(y))) && (u = y); - } - return ( - (h = U), - (E = p), - h.test(u) && E.test(u) && ((h = L), (u = u.replace(h, ''))), - k == 'y' && (u = k.toLowerCase() + u.substr(1)), - u - ); - }; - return function (A) { - return A.update(V); - }; - })()), - t.Pipeline.registerFunction(t.stemmer, 'stemmer'); - (t.generateStopWordFilter = function (e) { - var n = e.reduce(function (r, i) { - return (r[i] = i), r; - }, {}); - return function (r) { - if (r && n[r.toString()] !== r.toString()) return r; - }; - }), - (t.stopWordFilter = t.generateStopWordFilter([ - 'a', - 'able', - 'about', - 'across', - 'after', - 'all', - 'almost', - 'also', - 'am', - 'among', - 'an', - 'and', - 'any', - 'are', - 'as', - 'at', - 'be', - 'because', - 'been', - 'but', - 'by', - 'can', - 'cannot', - 'could', - 'dear', - 'did', - 'do', - 'does', - 'either', - 'else', - 'ever', - 'every', - 'for', - 'from', - 'get', - 'got', - 'had', - 'has', - 'have', - 'he', - 'her', - 'hers', - 'him', - 'his', - 'how', - 'however', - 'i', - 'if', - 'in', - 'into', - 'is', - 'it', - 'its', - 'just', - 'least', - 'let', - 'like', - 'likely', - 'may', - 'me', - 'might', - 'most', - 'must', - 'my', - 'neither', - 'no', - 'nor', - 'not', - 'of', - 'off', - 'often', - 'on', - 'only', - 'or', - 'other', - 'our', - 'own', - 'rather', - 'said', - 'say', - 'says', - 'she', - 'should', - 'since', - 'so', - 'some', - 'than', - 'that', - 'the', - 'their', - 'them', - 'then', - 'there', - 'these', - 'they', - 'this', - 'tis', - 'to', - 'too', - 'twas', - 'us', - 'wants', - 'was', - 'we', - 'were', - 'what', - 'when', - 'where', - 'which', - 'while', - 'who', - 'whom', - 'why', - 'will', - 'with', - 'would', - 'yet', - 'you', - 'your', - ])), - t.Pipeline.registerFunction(t.stopWordFilter, 'stopWordFilter'); - (t.trimmer = function (e) { - return e.update(function (n) { - return n.replace(/^\W+/, '').replace(/\W+$/, ''); - }); - }), - t.Pipeline.registerFunction(t.trimmer, 'trimmer'); - (t.TokenSet = function () { - (this.final = !1), - (this.edges = {}), - (this.id = t.TokenSet._nextId), - (t.TokenSet._nextId += 1); - }), - (t.TokenSet._nextId = 1), - (t.TokenSet.fromArray = function (e) { - for ( - var n = new t.TokenSet.Builder(), r = 0, i = e.length; - r < i; - r++ - ) - n.insert(e[r]); - return n.finish(), n.root; - }), - (t.TokenSet.fromClause = function (e) { - return 'editDistance' in e - ? t.TokenSet.fromFuzzyString(e.term, e.editDistance) - : t.TokenSet.fromString(e.term); - }), - (t.TokenSet.fromFuzzyString = function (e, n) { - for ( - var r = new t.TokenSet(), - i = [{ node: r, editsRemaining: n, str: e }]; - i.length; - - ) { - var s = i.pop(); - if (s.str.length > 0) { - var o = s.str.charAt(0), - a; - o in s.node.edges - ? (a = s.node.edges[o]) - : ((a = new t.TokenSet()), (s.node.edges[o] = a)), - s.str.length == 1 && (a.final = !0), - i.push({ - node: a, - editsRemaining: s.editsRemaining, - str: s.str.slice(1), - }); - } - if (s.editsRemaining != 0) { - if ('*' in s.node.edges) var c = s.node.edges['*']; - else { - var c = new t.TokenSet(); - s.node.edges['*'] = c; - } - if ( - (s.str.length == 0 && (c.final = !0), - i.push({ - node: c, - editsRemaining: s.editsRemaining - 1, - str: s.str, - }), - s.str.length > 1 && - i.push({ - node: s.node, - editsRemaining: s.editsRemaining - 1, - str: s.str.slice(1), - }), - s.str.length == 1 && (s.node.final = !0), - s.str.length >= 1) - ) { - if ('*' in s.node.edges) var l = s.node.edges['*']; - else { - var l = new t.TokenSet(); - s.node.edges['*'] = l; - } - s.str.length == 1 && (l.final = !0), - i.push({ - node: l, - editsRemaining: s.editsRemaining - 1, - str: s.str.slice(1), - }); - } - if (s.str.length > 1) { - var d = s.str.charAt(0), - f = s.str.charAt(1), - p; - f in s.node.edges - ? (p = s.node.edges[f]) - : ((p = new t.TokenSet()), (s.node.edges[f] = p)), - s.str.length == 1 && (p.final = !0), - i.push({ - node: p, - editsRemaining: s.editsRemaining - 1, - str: d + s.str.slice(2), - }); - } - } - } - return r; - }), - (t.TokenSet.fromString = function (e) { - for ( - var n = new t.TokenSet(), r = n, i = 0, s = e.length; - i < s; - i++ - ) { - var o = e[i], - a = i == s - 1; - if (o == '*') (n.edges[o] = n), (n.final = a); - else { - var c = new t.TokenSet(); - (c.final = a), (n.edges[o] = c), (n = c); - } - } - return r; - }), - (t.TokenSet.prototype.toArray = function () { - for (var e = [], n = [{ prefix: '', node: this }]; n.length; ) { - var r = n.pop(), - i = Object.keys(r.node.edges), - s = i.length; - r.node.final && (r.prefix.charAt(0), e.push(r.prefix)); - for (var o = 0; o < s; o++) { - var a = i[o]; - n.push({ prefix: r.prefix.concat(a), node: r.node.edges[a] }); - } - } - return e; - }), - (t.TokenSet.prototype.toString = function () { - if (this._str) return this._str; - for ( - var e = this.final ? '1' : '0', - n = Object.keys(this.edges).sort(), - r = n.length, - i = 0; - i < r; - i++ - ) { - var s = n[i], - o = this.edges[s]; - e = e + s + o.id; - } - return e; - }), - (t.TokenSet.prototype.intersect = function (e) { - for ( - var n = new t.TokenSet(), - r = void 0, - i = [{ qNode: e, output: n, node: this }]; - i.length; - - ) { - r = i.pop(); - for ( - var s = Object.keys(r.qNode.edges), - o = s.length, - a = Object.keys(r.node.edges), - c = a.length, - l = 0; - l < o; - l++ - ) - for (var d = s[l], f = 0; f < c; f++) { - var p = a[f]; - if (p == d || d == '*') { - var v = r.node.edges[p], - x = r.qNode.edges[d], - w = v.final && x.final, - m = void 0; - p in r.output.edges - ? ((m = r.output.edges[p]), (m.final = m.final || w)) - : ((m = new t.TokenSet()), - (m.final = w), - (r.output.edges[p] = m)), - i.push({ qNode: x, output: m, node: v }); - } - } - } - return n; - }), - (t.TokenSet.Builder = function () { - (this.previousWord = ''), - (this.root = new t.TokenSet()), - (this.uncheckedNodes = []), - (this.minimizedNodes = {}); - }), - (t.TokenSet.Builder.prototype.insert = function (e) { - var n, - r = 0; - if (e < this.previousWord) - throw new Error('Out of order word insertion'); - for ( - var i = 0; - i < e.length && - i < this.previousWord.length && - e[i] == this.previousWord[i]; - i++ - ) - r++; - this.minimize(r), - this.uncheckedNodes.length == 0 - ? (n = this.root) - : (n = this.uncheckedNodes[this.uncheckedNodes.length - 1].child); - for (var i = r; i < e.length; i++) { - var s = new t.TokenSet(), - o = e[i]; - (n.edges[o] = s), - this.uncheckedNodes.push({ parent: n, char: o, child: s }), - (n = s); - } - (n.final = !0), (this.previousWord = e); - }), - (t.TokenSet.Builder.prototype.finish = function () { - this.minimize(0); - }), - (t.TokenSet.Builder.prototype.minimize = function (e) { - for (var n = this.uncheckedNodes.length - 1; n >= e; n--) { - var r = this.uncheckedNodes[n], - i = r.child.toString(); - i in this.minimizedNodes - ? (r.parent.edges[r.char] = this.minimizedNodes[i]) - : ((r.child._str = i), (this.minimizedNodes[i] = r.child)), - this.uncheckedNodes.pop(); - } - }); - (t.Index = function (e) { - (this.invertedIndex = e.invertedIndex), - (this.fieldVectors = e.fieldVectors), - (this.tokenSet = e.tokenSet), - (this.fields = e.fields), - (this.pipeline = e.pipeline); - }), - (t.Index.prototype.search = function (e) { - return this.query(function (n) { - var r = new t.QueryParser(e, n); - r.parse(); - }); - }), - (t.Index.prototype.query = function (e) { - for ( - var n = new t.Query(this.fields), - r = Object.create(null), - i = Object.create(null), - s = Object.create(null), - o = Object.create(null), - a = Object.create(null), - c = 0; - c < this.fields.length; - c++ - ) - i[this.fields[c]] = new t.Vector(); - e.call(n, n); - for (var c = 0; c < n.clauses.length; c++) { - var l = n.clauses[c], - d = null, - f = t.Set.empty; - l.usePipeline - ? (d = this.pipeline.runString(l.term, { fields: l.fields })) - : (d = [l.term]); - for (var p = 0; p < d.length; p++) { - var v = d[p]; - l.term = v; - var x = t.TokenSet.fromClause(l), - w = this.tokenSet.intersect(x).toArray(); - if (w.length === 0 && l.presence === t.Query.presence.REQUIRED) { - for (var m = 0; m < l.fields.length; m++) { - var g = l.fields[m]; - o[g] = t.Set.empty; - } - break; - } - for (var T = 0; T < w.length; T++) - for ( - var L = w[T], C = this.invertedIndex[L], O = C._index, m = 0; - m < l.fields.length; - m++ - ) { - var g = l.fields[m], - j = C[g], - N = Object.keys(j), - q = L + '/' + g, - W = new t.Set(N); - if ( - (l.presence == t.Query.presence.REQUIRED && - ((f = f.union(W)), - o[g] === void 0 && (o[g] = t.Set.complete)), - l.presence == t.Query.presence.PROHIBITED) - ) { - a[g] === void 0 && (a[g] = t.Set.empty), - (a[g] = a[g].union(W)); - continue; - } - if ( - (i[g].upsert(O, l.boost, function (Ue, Je) { - return Ue + Je; - }), - !s[q]) - ) { - for (var B = 0; B < N.length; B++) { - var z = N[B], - _ = new t.FieldRef(z, g), - U = j[z], - J; - (J = r[_]) === void 0 - ? (r[_] = new t.MatchData(L, g, U)) - : J.add(L, g, U); - } - s[q] = !0; - } - } - } - if (l.presence === t.Query.presence.REQUIRED) - for (var m = 0; m < l.fields.length; m++) { - var g = l.fields[m]; - o[g] = o[g].intersect(f); - } - } - for ( - var V = t.Set.complete, A = t.Set.empty, c = 0; - c < this.fields.length; - c++ - ) { - var g = this.fields[c]; - o[g] && (V = V.intersect(o[g])), a[g] && (A = A.union(a[g])); - } - var u = Object.keys(r), - y = [], - P = Object.create(null); - if (n.isNegated()) { - u = Object.keys(this.fieldVectors); - for (var c = 0; c < u.length; c++) { - var _ = u[c], - k = t.FieldRef.fromString(_); - r[_] = new t.MatchData(); - } - } - for (var c = 0; c < u.length; c++) { - var k = t.FieldRef.fromString(u[c]), - h = k.docRef; - if (V.contains(h) && !A.contains(h)) { - var E = this.fieldVectors[k], - Q = i[k.fieldName].similarity(E), - H; - if ((H = P[h]) !== void 0) - (H.score += Q), H.matchData.combine(r[k]); - else { - var b = { ref: h, score: Q, matchData: r[k] }; - (P[h] = b), y.push(b); - } - } - } - return y.sort(function (We, ze) { - return ze.score - We.score; - }); - }), - (t.Index.prototype.toJSON = function () { - var e = Object.keys(this.invertedIndex) - .sort() - .map(function (r) { - return [r, this.invertedIndex[r]]; - }, this), - n = Object.keys(this.fieldVectors).map(function (r) { - return [r, this.fieldVectors[r].toJSON()]; - }, this); - return { - version: t.version, - fields: this.fields, - fieldVectors: n, - invertedIndex: e, - pipeline: this.pipeline.toJSON(), - }; - }), - (t.Index.load = function (e) { - var n = {}, - r = {}, - i = e.fieldVectors, - s = Object.create(null), - o = e.invertedIndex, - a = new t.TokenSet.Builder(), - c = t.Pipeline.load(e.pipeline); - e.version != t.version && - t.utils.warn( - "Version mismatch when loading serialised index. Current version of lunr '" + - t.version + - "' does not match serialized index '" + - e.version + - "'" - ); - for (var l = 0; l < i.length; l++) { - var d = i[l], - f = d[0], - p = d[1]; - r[f] = new t.Vector(p); - } - for (var l = 0; l < o.length; l++) { - var d = o[l], - v = d[0], - x = d[1]; - a.insert(v), (s[v] = x); - } - return ( - a.finish(), - (n.fields = e.fields), - (n.fieldVectors = r), - (n.invertedIndex = s), - (n.tokenSet = a.root), - (n.pipeline = c), - new t.Index(n) - ); - }); - (t.Builder = function () { - (this._ref = 'id'), - (this._fields = Object.create(null)), - (this._documents = Object.create(null)), - (this.invertedIndex = Object.create(null)), - (this.fieldTermFrequencies = {}), - (this.fieldLengths = {}), - (this.tokenizer = t.tokenizer), - (this.pipeline = new t.Pipeline()), - (this.searchPipeline = new t.Pipeline()), - (this.documentCount = 0), - (this._b = 0.75), - (this._k1 = 1.2), - (this.termIndex = 0), - (this.metadataWhitelist = []); - }), - (t.Builder.prototype.ref = function (e) { - this._ref = e; - }), - (t.Builder.prototype.field = function (e, n) { - if (/\//.test(e)) - throw new RangeError( - "Field '" + e + "' contains illegal character '/'" - ); - this._fields[e] = n || {}; - }), - (t.Builder.prototype.b = function (e) { - e < 0 ? (this._b = 0) : e > 1 ? (this._b = 1) : (this._b = e); - }), - (t.Builder.prototype.k1 = function (e) { - this._k1 = e; - }), - (t.Builder.prototype.add = function (e, n) { - var r = e[this._ref], - i = Object.keys(this._fields); - (this._documents[r] = n || {}), (this.documentCount += 1); - for (var s = 0; s < i.length; s++) { - var o = i[s], - a = this._fields[o].extractor, - c = a ? a(e) : e[o], - l = this.tokenizer(c, { fields: [o] }), - d = this.pipeline.run(l), - f = new t.FieldRef(r, o), - p = Object.create(null); - (this.fieldTermFrequencies[f] = p), - (this.fieldLengths[f] = 0), - (this.fieldLengths[f] += d.length); - for (var v = 0; v < d.length; v++) { - var x = d[v]; - if ( - (p[x] == null && (p[x] = 0), - (p[x] += 1), - this.invertedIndex[x] == null) - ) { - var w = Object.create(null); - (w._index = this.termIndex), (this.termIndex += 1); - for (var m = 0; m < i.length; m++) - w[i[m]] = Object.create(null); - this.invertedIndex[x] = w; - } - this.invertedIndex[x][o][r] == null && - (this.invertedIndex[x][o][r] = Object.create(null)); - for (var g = 0; g < this.metadataWhitelist.length; g++) { - var T = this.metadataWhitelist[g], - L = x.metadata[T]; - this.invertedIndex[x][o][r][T] == null && - (this.invertedIndex[x][o][r][T] = []), - this.invertedIndex[x][o][r][T].push(L); - } - } - } - }), - (t.Builder.prototype.calculateAverageFieldLengths = function () { - for ( - var e = Object.keys(this.fieldLengths), - n = e.length, - r = {}, - i = {}, - s = 0; - s < n; - s++ - ) { - var o = t.FieldRef.fromString(e[s]), - a = o.fieldName; - i[a] || (i[a] = 0), - (i[a] += 1), - r[a] || (r[a] = 0), - (r[a] += this.fieldLengths[o]); - } - for (var c = Object.keys(this._fields), s = 0; s < c.length; s++) { - var l = c[s]; - r[l] = r[l] / i[l]; - } - this.averageFieldLength = r; - }), - (t.Builder.prototype.createFieldVectors = function () { - for ( - var e = {}, - n = Object.keys(this.fieldTermFrequencies), - r = n.length, - i = Object.create(null), - s = 0; - s < r; - s++ - ) { - for ( - var o = t.FieldRef.fromString(n[s]), - a = o.fieldName, - c = this.fieldLengths[o], - l = new t.Vector(), - d = this.fieldTermFrequencies[o], - f = Object.keys(d), - p = f.length, - v = this._fields[a].boost || 1, - x = this._documents[o.docRef].boost || 1, - w = 0; - w < p; - w++ - ) { - var m = f[w], - g = d[m], - T = this.invertedIndex[m]._index, - L, - C, - O; - i[m] === void 0 - ? ((L = t.idf(this.invertedIndex[m], this.documentCount)), - (i[m] = L)) - : (L = i[m]), - (C = - (L * ((this._k1 + 1) * g)) / - (this._k1 * - (1 - this._b + this._b * (c / this.averageFieldLength[a])) + - g)), - (C *= v), - (C *= x), - (O = Math.round(C * 1e3) / 1e3), - l.insert(T, O); - } - e[o] = l; - } - this.fieldVectors = e; - }), - (t.Builder.prototype.createTokenSet = function () { - this.tokenSet = t.TokenSet.fromArray( - Object.keys(this.invertedIndex).sort() - ); - }), - (t.Builder.prototype.build = function () { - return ( - this.calculateAverageFieldLengths(), - this.createFieldVectors(), - this.createTokenSet(), - new t.Index({ - invertedIndex: this.invertedIndex, - fieldVectors: this.fieldVectors, - tokenSet: this.tokenSet, - fields: Object.keys(this._fields), - pipeline: this.searchPipeline, - }) - ); - }), - (t.Builder.prototype.use = function (e) { - var n = Array.prototype.slice.call(arguments, 1); - n.unshift(this), e.apply(this, n); - }), - (t.MatchData = function (e, n, r) { - for ( - var i = Object.create(null), s = Object.keys(r || {}), o = 0; - o < s.length; - o++ - ) { - var a = s[o]; - i[a] = r[a].slice(); - } - (this.metadata = Object.create(null)), - e !== void 0 && - ((this.metadata[e] = Object.create(null)), - (this.metadata[e][n] = i)); - }), - (t.MatchData.prototype.combine = function (e) { - for (var n = Object.keys(e.metadata), r = 0; r < n.length; r++) { - var i = n[r], - s = Object.keys(e.metadata[i]); - this.metadata[i] == null && - (this.metadata[i] = Object.create(null)); - for (var o = 0; o < s.length; o++) { - var a = s[o], - c = Object.keys(e.metadata[i][a]); - this.metadata[i][a] == null && - (this.metadata[i][a] = Object.create(null)); - for (var l = 0; l < c.length; l++) { - var d = c[l]; - this.metadata[i][a][d] == null - ? (this.metadata[i][a][d] = e.metadata[i][a][d]) - : (this.metadata[i][a][d] = this.metadata[i][a][d].concat( - e.metadata[i][a][d] - )); - } - } - } - }), - (t.MatchData.prototype.add = function (e, n, r) { - if (!(e in this.metadata)) { - (this.metadata[e] = Object.create(null)), (this.metadata[e][n] = r); - return; - } - if (!(n in this.metadata[e])) { - this.metadata[e][n] = r; - return; - } - for (var i = Object.keys(r), s = 0; s < i.length; s++) { - var o = i[s]; - o in this.metadata[e][n] - ? (this.metadata[e][n][o] = this.metadata[e][n][o].concat(r[o])) - : (this.metadata[e][n][o] = r[o]); - } - }), - (t.Query = function (e) { - (this.clauses = []), (this.allFields = e); - }), - (t.Query.wildcard = new String('*')), - (t.Query.wildcard.NONE = 0), - (t.Query.wildcard.LEADING = 1), - (t.Query.wildcard.TRAILING = 2), - (t.Query.presence = { OPTIONAL: 1, REQUIRED: 2, PROHIBITED: 3 }), - (t.Query.prototype.clause = function (e) { - return ( - 'fields' in e || (e.fields = this.allFields), - 'boost' in e || (e.boost = 1), - 'usePipeline' in e || (e.usePipeline = !0), - 'wildcard' in e || (e.wildcard = t.Query.wildcard.NONE), - e.wildcard & t.Query.wildcard.LEADING && - e.term.charAt(0) != t.Query.wildcard && - (e.term = '*' + e.term), - e.wildcard & t.Query.wildcard.TRAILING && - e.term.slice(-1) != t.Query.wildcard && - (e.term = '' + e.term + '*'), - 'presence' in e || (e.presence = t.Query.presence.OPTIONAL), - this.clauses.push(e), - this - ); - }), - (t.Query.prototype.isNegated = function () { - for (var e = 0; e < this.clauses.length; e++) - if (this.clauses[e].presence != t.Query.presence.PROHIBITED) - return !1; - return !0; - }), - (t.Query.prototype.term = function (e, n) { - if (Array.isArray(e)) - return ( - e.forEach(function (i) { - this.term(i, t.utils.clone(n)); - }, this), - this - ); - var r = n || {}; - return (r.term = e.toString()), this.clause(r), this; - }), - (t.QueryParseError = function (e, n, r) { - (this.name = 'QueryParseError'), - (this.message = e), - (this.start = n), - (this.end = r); - }), - (t.QueryParseError.prototype = new Error()), - (t.QueryLexer = function (e) { - (this.lexemes = []), - (this.str = e), - (this.length = e.length), - (this.pos = 0), - (this.start = 0), - (this.escapeCharPositions = []); - }), - (t.QueryLexer.prototype.run = function () { - for (var e = t.QueryLexer.lexText; e; ) e = e(this); - }), - (t.QueryLexer.prototype.sliceString = function () { - for ( - var e = [], n = this.start, r = this.pos, i = 0; - i < this.escapeCharPositions.length; - i++ - ) - (r = this.escapeCharPositions[i]), - e.push(this.str.slice(n, r)), - (n = r + 1); - return ( - e.push(this.str.slice(n, this.pos)), - (this.escapeCharPositions.length = 0), - e.join('') - ); - }), - (t.QueryLexer.prototype.emit = function (e) { - this.lexemes.push({ - type: e, - str: this.sliceString(), - start: this.start, - end: this.pos, - }), - (this.start = this.pos); - }), - (t.QueryLexer.prototype.escapeCharacter = function () { - this.escapeCharPositions.push(this.pos - 1), (this.pos += 1); - }), - (t.QueryLexer.prototype.next = function () { - if (this.pos >= this.length) return t.QueryLexer.EOS; - var e = this.str.charAt(this.pos); - return (this.pos += 1), e; - }), - (t.QueryLexer.prototype.width = function () { - return this.pos - this.start; - }), - (t.QueryLexer.prototype.ignore = function () { - this.start == this.pos && (this.pos += 1), (this.start = this.pos); - }), - (t.QueryLexer.prototype.backup = function () { - this.pos -= 1; - }), - (t.QueryLexer.prototype.acceptDigitRun = function () { - var e, n; - do (e = this.next()), (n = e.charCodeAt(0)); - while (n > 47 && n < 58); - e != t.QueryLexer.EOS && this.backup(); - }), - (t.QueryLexer.prototype.more = function () { - return this.pos < this.length; - }), - (t.QueryLexer.EOS = 'EOS'), - (t.QueryLexer.FIELD = 'FIELD'), - (t.QueryLexer.TERM = 'TERM'), - (t.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'), - (t.QueryLexer.BOOST = 'BOOST'), - (t.QueryLexer.PRESENCE = 'PRESENCE'), - (t.QueryLexer.lexField = function (e) { - return ( - e.backup(), - e.emit(t.QueryLexer.FIELD), - e.ignore(), - t.QueryLexer.lexText - ); - }), - (t.QueryLexer.lexTerm = function (e) { - if ( - (e.width() > 1 && (e.backup(), e.emit(t.QueryLexer.TERM)), - e.ignore(), - e.more()) - ) - return t.QueryLexer.lexText; - }), - (t.QueryLexer.lexEditDistance = function (e) { - return ( - e.ignore(), - e.acceptDigitRun(), - e.emit(t.QueryLexer.EDIT_DISTANCE), - t.QueryLexer.lexText - ); - }), - (t.QueryLexer.lexBoost = function (e) { - return ( - e.ignore(), - e.acceptDigitRun(), - e.emit(t.QueryLexer.BOOST), - t.QueryLexer.lexText - ); - }), - (t.QueryLexer.lexEOS = function (e) { - e.width() > 0 && e.emit(t.QueryLexer.TERM); - }), - (t.QueryLexer.termSeparator = t.tokenizer.separator), - (t.QueryLexer.lexText = function (e) { - for (;;) { - var n = e.next(); - if (n == t.QueryLexer.EOS) return t.QueryLexer.lexEOS; - if (n.charCodeAt(0) == 92) { - e.escapeCharacter(); - continue; - } - if (n == ':') return t.QueryLexer.lexField; - if (n == '~') - return ( - e.backup(), - e.width() > 0 && e.emit(t.QueryLexer.TERM), - t.QueryLexer.lexEditDistance - ); - if (n == '^') - return ( - e.backup(), - e.width() > 0 && e.emit(t.QueryLexer.TERM), - t.QueryLexer.lexBoost - ); - if ((n == '+' && e.width() === 1) || (n == '-' && e.width() === 1)) - return e.emit(t.QueryLexer.PRESENCE), t.QueryLexer.lexText; - if (n.match(t.QueryLexer.termSeparator)) - return t.QueryLexer.lexTerm; - } - }), - (t.QueryParser = function (e, n) { - (this.lexer = new t.QueryLexer(e)), - (this.query = n), - (this.currentClause = {}), - (this.lexemeIdx = 0); - }), - (t.QueryParser.prototype.parse = function () { - this.lexer.run(), (this.lexemes = this.lexer.lexemes); - for (var e = t.QueryParser.parseClause; e; ) e = e(this); - return this.query; - }), - (t.QueryParser.prototype.peekLexeme = function () { - return this.lexemes[this.lexemeIdx]; - }), - (t.QueryParser.prototype.consumeLexeme = function () { - var e = this.peekLexeme(); - return (this.lexemeIdx += 1), e; - }), - (t.QueryParser.prototype.nextClause = function () { - var e = this.currentClause; - this.query.clause(e), (this.currentClause = {}); - }), - (t.QueryParser.parseClause = function (e) { - var n = e.peekLexeme(); - if (n != null) - switch (n.type) { - case t.QueryLexer.PRESENCE: - return t.QueryParser.parsePresence; - case t.QueryLexer.FIELD: - return t.QueryParser.parseField; - case t.QueryLexer.TERM: - return t.QueryParser.parseTerm; - default: - var r = 'expected either a field or a term, found ' + n.type; - throw ( - (n.str.length >= 1 && (r += " with value '" + n.str + "'"), - new t.QueryParseError(r, n.start, n.end)) - ); - } - }), - (t.QueryParser.parsePresence = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - switch (n.str) { - case '-': - e.currentClause.presence = t.Query.presence.PROHIBITED; - break; - case '+': - e.currentClause.presence = t.Query.presence.REQUIRED; - break; - default: - var r = "unrecognised presence operator'" + n.str + "'"; - throw new t.QueryParseError(r, n.start, n.end); - } - var i = e.peekLexeme(); - if (i == null) { - var r = 'expecting term or field, found nothing'; - throw new t.QueryParseError(r, n.start, n.end); - } - switch (i.type) { - case t.QueryLexer.FIELD: - return t.QueryParser.parseField; - case t.QueryLexer.TERM: - return t.QueryParser.parseTerm; - default: - var r = "expecting term or field, found '" + i.type + "'"; - throw new t.QueryParseError(r, i.start, i.end); - } - } - }), - (t.QueryParser.parseField = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - if (e.query.allFields.indexOf(n.str) == -1) { - var r = e.query.allFields - .map(function (o) { - return "'" + o + "'"; - }) - .join(', '), - i = "unrecognised field '" + n.str + "', possible fields: " + r; - throw new t.QueryParseError(i, n.start, n.end); - } - e.currentClause.fields = [n.str]; - var s = e.peekLexeme(); - if (s == null) { - var i = 'expecting term, found nothing'; - throw new t.QueryParseError(i, n.start, n.end); - } - if (s.type === t.QueryLexer.TERM) return t.QueryParser.parseTerm; - var i = "expecting term, found '" + s.type + "'"; - throw new t.QueryParseError(i, s.start, s.end); - } - }), - (t.QueryParser.parseTerm = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - (e.currentClause.term = n.str.toLowerCase()), - n.str.indexOf('*') != -1 && (e.currentClause.usePipeline = !1); - var r = e.peekLexeme(); - if (r == null) { - e.nextClause(); - return; - } - switch (r.type) { - case t.QueryLexer.TERM: - return e.nextClause(), t.QueryParser.parseTerm; - case t.QueryLexer.FIELD: - return e.nextClause(), t.QueryParser.parseField; - case t.QueryLexer.EDIT_DISTANCE: - return t.QueryParser.parseEditDistance; - case t.QueryLexer.BOOST: - return t.QueryParser.parseBoost; - case t.QueryLexer.PRESENCE: - return e.nextClause(), t.QueryParser.parsePresence; - default: - var i = "Unexpected lexeme type '" + r.type + "'"; - throw new t.QueryParseError(i, r.start, r.end); - } - } - }), - (t.QueryParser.parseEditDistance = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - var r = parseInt(n.str, 10); - if (isNaN(r)) { - var i = 'edit distance must be numeric'; - throw new t.QueryParseError(i, n.start, n.end); - } - e.currentClause.editDistance = r; - var s = e.peekLexeme(); - if (s == null) { - e.nextClause(); - return; - } - switch (s.type) { - case t.QueryLexer.TERM: - return e.nextClause(), t.QueryParser.parseTerm; - case t.QueryLexer.FIELD: - return e.nextClause(), t.QueryParser.parseField; - case t.QueryLexer.EDIT_DISTANCE: - return t.QueryParser.parseEditDistance; - case t.QueryLexer.BOOST: - return t.QueryParser.parseBoost; - case t.QueryLexer.PRESENCE: - return e.nextClause(), t.QueryParser.parsePresence; - default: - var i = "Unexpected lexeme type '" + s.type + "'"; - throw new t.QueryParseError(i, s.start, s.end); - } - } - }), - (t.QueryParser.parseBoost = function (e) { - var n = e.consumeLexeme(); - if (n != null) { - var r = parseInt(n.str, 10); - if (isNaN(r)) { - var i = 'boost must be numeric'; - throw new t.QueryParseError(i, n.start, n.end); - } - e.currentClause.boost = r; - var s = e.peekLexeme(); - if (s == null) { - e.nextClause(); - return; - } - switch (s.type) { - case t.QueryLexer.TERM: - return e.nextClause(), t.QueryParser.parseTerm; - case t.QueryLexer.FIELD: - return e.nextClause(), t.QueryParser.parseField; - case t.QueryLexer.EDIT_DISTANCE: - return t.QueryParser.parseEditDistance; - case t.QueryLexer.BOOST: - return t.QueryParser.parseBoost; - case t.QueryLexer.PRESENCE: - return e.nextClause(), t.QueryParser.parsePresence; - default: - var i = "Unexpected lexeme type '" + s.type + "'"; - throw new t.QueryParseError(i, s.start, s.end); - } - } - }), - (function (e, n) { - typeof define == 'function' && define.amd - ? define(n) - : typeof me == 'object' - ? (ge.exports = n()) - : (e.lunr = n()); - })(this, function () { - return t; - }); - })(); - }); - var M, - G = { - getItem() { - return null; - }, - setItem() {}, - }, - K; - try { - (K = localStorage), (M = K); - } catch { - (K = G), (M = G); - } - var S = { - getItem: (t) => M.getItem(t), - setItem: (t, e) => M.setItem(t, e), - disableWritingLocalStorage() { - M = G; - }, - disable() { - localStorage.clear(), (M = G); - }, - enable() { - M = K; - }, - }; - window.TypeDoc ||= { - disableWritingLocalStorage() { - S.disableWritingLocalStorage(); - }, - disableLocalStorage: () => { - S.disable(); - }, - enableLocalStorage: () => { - S.enable(); - }, - }; - window.translations ||= { - copy: 'Copy', - copied: 'Copied!', - normally_hidden: - 'This member is normally hidden due to your filter settings.', - hierarchy_expand: 'Expand', - hierarchy_collapse: 'Collapse', - search_index_not_available: 'The search index is not available', - search_no_results_found_for_0: 'No results found for {0}', - folder: 'Folder', - kind_1: 'Project', - kind_2: 'Module', - kind_4: 'Namespace', - kind_8: 'Enumeration', - kind_16: 'Enumeration Member', - kind_32: 'Variable', - kind_64: 'Function', - kind_128: 'Class', - kind_256: 'Interface', - kind_512: 'Constructor', - kind_1024: 'Property', - kind_2048: 'Method', - kind_4096: 'Call Signature', - kind_8192: 'Index Signature', - kind_16384: 'Constructor Signature', - kind_32768: 'Parameter', - kind_65536: 'Type Literal', - kind_131072: 'Type Parameter', - kind_262144: 'Accessor', - kind_524288: 'Get Signature', - kind_1048576: 'Set Signature', - kind_2097152: 'Type Alias', - kind_4194304: 'Reference', - kind_8388608: 'Document', - }; - var pe = []; - function X(t, e) { - pe.push({ selector: e, constructor: t }); - } - var Z = class { - alwaysVisibleMember = null; - constructor() { - this.createComponents(document.body), - this.ensureFocusedElementVisible(), - this.listenForCodeCopies(), - window.addEventListener('hashchange', () => - this.ensureFocusedElementVisible() - ), - document.body.style.display || - (this.ensureFocusedElementVisible(), - this.updateIndexVisibility(), - this.scrollToHash()); - } - createComponents(e) { - pe.forEach((n) => { - e.querySelectorAll(n.selector).forEach((r) => { - r.dataset.hasInstance || - (new n.constructor({ el: r, app: this }), - (r.dataset.hasInstance = String(!0))); - }); - }); - } - filterChanged() { - this.ensureFocusedElementVisible(); - } - showPage() { - document.body.style.display && - (document.body.style.removeProperty('display'), - this.ensureFocusedElementVisible(), - this.updateIndexVisibility(), - this.scrollToHash()); - } - scrollToHash() { - if (location.hash) { - let e = document.getElementById(location.hash.substring(1)); - if (!e) return; - e.scrollIntoView({ behavior: 'instant', block: 'start' }); - } - } - ensureActivePageVisible() { - let e = document.querySelector('.tsd-navigation .current'), - n = e?.parentElement; - for (; n && !n.classList.contains('.tsd-navigation'); ) - n instanceof HTMLDetailsElement && (n.open = !0), (n = n.parentElement); - if (e && !rt(e)) { - let r = - e.getBoundingClientRect().top - - document.documentElement.clientHeight / 4; - (document.querySelector('.site-menu').scrollTop = r), - (document.querySelector('.col-sidebar').scrollTop = r); - } - } - updateIndexVisibility() { - let e = document.querySelector('.tsd-index-content'), - n = e?.open; - e && (e.open = !0), - document.querySelectorAll('.tsd-index-section').forEach((r) => { - r.style.display = 'block'; - let i = Array.from(r.querySelectorAll('.tsd-index-link')).every( - (s) => s.offsetParent == null - ); - r.style.display = i ? 'none' : 'block'; - }), - e && (e.open = n); - } - ensureFocusedElementVisible() { - if ( - (this.alwaysVisibleMember && - (this.alwaysVisibleMember.classList.remove('always-visible'), - this.alwaysVisibleMember.firstElementChild.remove(), - (this.alwaysVisibleMember = null)), - !location.hash) - ) - return; - let e = document.getElementById(location.hash.substring(1)); - if (!e) return; - let n = e.parentElement; - for (; n && n.tagName !== 'SECTION'; ) n = n.parentElement; - if (!n) return; - let r = n.offsetParent == null, - i = n; - for (; i !== document.body; ) - i instanceof HTMLDetailsElement && (i.open = !0), (i = i.parentElement); - if (n.offsetParent == null) { - (this.alwaysVisibleMember = n), n.classList.add('always-visible'); - let s = document.createElement('p'); - s.classList.add('warning'), - (s.textContent = window.translations.normally_hidden), - n.prepend(s); - } - r && e.scrollIntoView(); - } - listenForCodeCopies() { - document.querySelectorAll('pre > button').forEach((e) => { - let n; - e.addEventListener('click', () => { - e.previousElementSibling instanceof HTMLElement && - navigator.clipboard.writeText( - e.previousElementSibling.innerText.trim() - ), - (e.textContent = window.translations.copied), - e.classList.add('visible'), - clearTimeout(n), - (n = setTimeout(() => { - e.classList.remove('visible'), - (n = setTimeout(() => { - e.textContent = window.translations.copy; - }, 100)); - }, 1e3)); - }); - }); - } - }; - function rt(t) { - let e = t.getBoundingClientRect(), - n = Math.max(document.documentElement.clientHeight, window.innerHeight); - return !(e.bottom < 0 || e.top - n >= 0); - } - var fe = (t, e = 100) => { - let n; - return () => { - clearTimeout(n), (n = setTimeout(() => t(), e)); - }; - }; - var Ie = nt(ye(), 1); - async function R(t) { - let e = Uint8Array.from(atob(t), (s) => s.charCodeAt(0)), - r = new Blob([e]) - .stream() - .pipeThrough(new DecompressionStream('deflate')), - i = await new Response(r).text(); - return JSON.parse(i); - } - var Y = 'closing', - ae = 'tsd-overlay'; - function it() { - let t = Math.abs(window.innerWidth - document.documentElement.clientWidth); - (document.body.style.overflow = 'hidden'), - (document.body.style.paddingRight = `${t}px`); - } - function st() { - document.body.style.removeProperty('overflow'), - document.body.style.removeProperty('padding-right'); - } - function xe(t, e) { - t.addEventListener('animationend', () => { - t.classList.contains(Y) && - (t.classList.remove(Y), - document.getElementById(ae)?.remove(), - t.close(), - st()); - }), - t.addEventListener('cancel', (n) => { - n.preventDefault(), ve(t); - }), - e?.closeOnClick && - document.addEventListener( - 'click', - (n) => { - t.open && !t.contains(n.target) && ve(t); - }, - !0 - ); - } - function Ee(t) { - if (t.open) return; - let e = document.createElement('div'); - (e.id = ae), document.body.appendChild(e), t.showModal(), it(); - } - function ve(t) { - if (!t.open) return; - document.getElementById(ae)?.classList.add(Y), t.classList.add(Y); - } - var I = class { - el; - app; - constructor(e) { - (this.el = e.el), (this.app = e.app); - } - }; - var be = document.head.appendChild(document.createElement('style')); - be.dataset.for = 'filters'; - var le = {}; - function we(t) { - for (let e of t.split(/\s+/)) if (le.hasOwnProperty(e) && !le[e]) return !0; - return !1; - } - var ee = class extends I { - key; - value; - constructor(e) { - super(e), - (this.key = `filter-${this.el.name}`), - (this.value = this.el.checked), - this.el.addEventListener('change', () => { - this.setLocalStorage(this.el.checked); - }), - this.setLocalStorage(this.fromLocalStorage()), - (be.innerHTML += `html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`), - this.app.updateIndexVisibility(); - } - fromLocalStorage() { - let e = S.getItem(this.key); - return e ? e === 'true' : this.el.checked; - } - setLocalStorage(e) { - S.setItem(this.key, e.toString()), - (this.value = e), - this.handleValueChange(); - } - handleValueChange() { - (this.el.checked = this.value), - document.documentElement.classList.toggle(this.key, this.value), - (le[`tsd-is-${this.el.name}`] = this.value), - this.app.filterChanged(), - this.app.updateIndexVisibility(); - } - }; - var Le = 0; - async function Se(t, e) { - if (!window.searchData) return; - let n = await R(window.searchData); - (t.data = n), (t.index = Ie.Index.load(n.index)), (e.innerHTML = ''); - } - function _e() { - let t = document.getElementById('tsd-search-trigger'), - e = document.getElementById('tsd-search'), - n = document.getElementById('tsd-search-input'), - r = document.getElementById('tsd-search-results'), - i = document.getElementById('tsd-search-script'), - s = document.getElementById('tsd-search-status'); - if (!(t && e && n && r && i && s)) - throw new Error('Search controls missing'); - let o = { base: document.documentElement.dataset.base }; - o.base.endsWith('/') || (o.base += '/'), - i.addEventListener('error', () => { - let a = window.translations.search_index_not_available; - Pe(s, a); - }), - i.addEventListener('load', () => { - Se(o, s); - }), - Se(o, s), - ot({ trigger: t, searchEl: e, results: r, field: n, status: s }, o); - } - function ot(t, e) { - let { field: n, results: r, searchEl: i, status: s, trigger: o } = t; - xe(i, { closeOnClick: !0 }); - function a() { - Ee(i), n.setSelectionRange(0, n.value.length); - } - o.addEventListener('click', a), - n.addEventListener( - 'input', - fe(() => { - at(r, n, s, e); - }, 200) - ), - n.addEventListener('keydown', (l) => { - if (r.childElementCount === 0 || l.ctrlKey || l.metaKey || l.altKey) - return; - let d = n.getAttribute('aria-activedescendant'), - f = d ? document.getElementById(d) : null; - if (f) { - let p = !1, - v = !1; - switch (l.key) { - case 'Home': - case 'End': - case 'ArrowLeft': - case 'ArrowRight': - v = !0; - break; - case 'ArrowDown': - case 'ArrowUp': - p = l.shiftKey; - break; - } - (p || v) && ke(n); - } - if (!l.shiftKey) - switch (l.key) { - case 'Enter': - f?.querySelector('a')?.click(); - break; - case 'ArrowUp': - Te(r, n, f, -1), l.preventDefault(); - break; - case 'ArrowDown': - Te(r, n, f, 1), l.preventDefault(); - break; - } - }); - function c() { - ke(n); - } - n.addEventListener('change', c), - n.addEventListener('blur', c), - n.addEventListener('click', c), - document.body.addEventListener('keydown', (l) => { - if (l.altKey || l.metaKey || l.shiftKey) return; - let d = l.ctrlKey && l.key === 'k', - f = !l.ctrlKey && !ut() && l.key === '/'; - (d || f) && (l.preventDefault(), a()); - }); - } - function at(t, e, n, r) { - if (!r.index || !r.data) return; - (t.innerHTML = ''), (n.innerHTML = ''), (Le += 1); - let i = e.value.trim(), - s; - if (i) { - let a = i - .split(' ') - .map((c) => (c.length ? `*${c}*` : '')) - .join(' '); - s = r.index.search(a).filter(({ ref: c }) => { - let l = r.data.rows[Number(c)].classes; - return !l || !we(l); - }); - } else s = []; - if (s.length === 0 && i) { - let a = window.translations.search_no_results_found_for_0.replace( - '{0}', - ` "${te(i)}" ` - ); - Pe(n, a); - return; - } - for (let a = 0; a < s.length; a++) { - let c = s[a], - l = r.data.rows[Number(c.ref)], - d = 1; - l.name.toLowerCase().startsWith(i.toLowerCase()) && - (d *= 10 / (1 + Math.abs(l.name.length - i.length))), - (c.score *= d); - } - s.sort((a, c) => c.score - a.score); - let o = Math.min(10, s.length); - for (let a = 0; a < o; a++) { - let c = r.data.rows[Number(s[a].ref)], - d = ``, - f = Ce(c.name, i); - globalThis.DEBUG_SEARCH_WEIGHTS && - (f += ` (score: ${s[a].score.toFixed(2)})`), - c.parent && - (f = ` - ${Ce(c.parent, i)}.${f}`); - let p = document.createElement('li'); - (p.id = `tsd-search:${Le}-${a}`), - (p.role = 'option'), - (p.ariaSelected = 'false'), - (p.classList.value = c.classes ?? ''); - let v = document.createElement('a'); - (v.tabIndex = -1), - (v.href = r.base + c.url), - (v.innerHTML = d + `${f}`), - p.append(v), - t.appendChild(p); - } - } - function Te(t, e, n, r) { - let i; - if ( - (r === 1 - ? (i = n?.nextElementSibling || t.firstElementChild) - : (i = n?.previousElementSibling || t.lastElementChild), - i !== n) - ) { - if (!i || i.role !== 'option') { - console.error('Option missing'); - return; - } - (i.ariaSelected = 'true'), - i.scrollIntoView({ behavior: 'smooth', block: 'nearest' }), - e.setAttribute('aria-activedescendant', i.id), - n?.setAttribute('aria-selected', 'false'); - } - } - function ke(t) { - let e = t.getAttribute('aria-activedescendant'); - (e ? document.getElementById(e) : null)?.setAttribute( - 'aria-selected', - 'false' - ), - t.setAttribute('aria-activedescendant', ''); - } - function Ce(t, e) { - if (e === '') return t; - let n = t.toLocaleLowerCase(), - r = e.toLocaleLowerCase(), - i = [], - s = 0, - o = n.indexOf(r); - for (; o != -1; ) - i.push( - te(t.substring(s, o)), - `${te(t.substring(o, o + r.length))}` - ), - (s = o + r.length), - (o = n.indexOf(r, s)); - return i.push(te(t.substring(s))), i.join(''); - } - var lt = { - '&': '&', - '<': '<', - '>': '>', - "'": ''', - '"': '"', - }; - function te(t) { - return t.replace(/[&<>"'"]/g, (e) => lt[e]); - } - function Pe(t, e) { - t.innerHTML = e ? `
${e}
` : ''; - } - var ct = [ - 'button', - 'checkbox', - 'file', - 'hidden', - 'image', - 'radio', - 'range', - 'reset', - 'submit', - ]; - function ut() { - let t = document.activeElement; - return t - ? t.isContentEditable || - t.tagName === 'TEXTAREA' || - t.tagName === 'SEARCH' - ? !0 - : t.tagName === 'INPUT' && !ct.includes(t.type) - : !1; - } - var D = 'mousedown', - Me = 'mousemove', - $ = 'mouseup', - ne = { x: 0, y: 0 }, - Qe = !1, - ce = !1, - dt = !1, - F = !1, - Oe = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( - navigator.userAgent - ); - document.documentElement.classList.add(Oe ? 'is-mobile' : 'not-mobile'); - Oe && - 'ontouchstart' in document.documentElement && - ((dt = !0), (D = 'touchstart'), (Me = 'touchmove'), ($ = 'touchend')); - document.addEventListener(D, (t) => { - (ce = !0), (F = !1); - let e = D == 'touchstart' ? t.targetTouches[0] : t; - (ne.y = e.pageY || 0), (ne.x = e.pageX || 0); - }); - document.addEventListener(Me, (t) => { - if (ce && !F) { - let e = D == 'touchstart' ? t.targetTouches[0] : t, - n = ne.x - (e.pageX || 0), - r = ne.y - (e.pageY || 0); - F = Math.sqrt(n * n + r * r) > 10; - } - }); - document.addEventListener($, () => { - ce = !1; - }); - document.addEventListener('click', (t) => { - Qe && (t.preventDefault(), t.stopImmediatePropagation(), (Qe = !1)); - }); - var re = class extends I { - active; - className; - constructor(e) { - super(e), - (this.className = this.el.dataset.toggle || ''), - this.el.addEventListener($, (n) => this.onPointerUp(n)), - this.el.addEventListener('click', (n) => n.preventDefault()), - document.addEventListener(D, (n) => this.onDocumentPointerDown(n)), - document.addEventListener($, (n) => this.onDocumentPointerUp(n)); - } - setActive(e) { - if (this.active == e) return; - (this.active = e), - document.documentElement.classList.toggle('has-' + this.className, e), - this.el.classList.toggle('active', e); - let n = (this.active ? 'to-has-' : 'from-has-') + this.className; - document.documentElement.classList.add(n), - setTimeout(() => document.documentElement.classList.remove(n), 500); - } - onPointerUp(e) { - F || (this.setActive(!0), e.preventDefault()); - } - onDocumentPointerDown(e) { - if (this.active) { - if (e.target.closest('.col-sidebar, .tsd-filter-group')) return; - this.setActive(!1); - } - } - onDocumentPointerUp(e) { - if (!F && this.active && e.target.closest('.col-sidebar')) { - let n = e.target.closest('a'); - if (n) { - let r = window.location.href; - r.indexOf('#') != -1 && (r = r.substring(0, r.indexOf('#'))), - n.href.substring(0, r.length) == r && - setTimeout(() => this.setActive(!1), 250); - } - } - } - }; - var ue = new Map(), - de = class { - open; - accordions = []; - key; - constructor(e, n) { - (this.key = e), (this.open = n); - } - add(e) { - this.accordions.push(e), - (e.open = this.open), - e.addEventListener('toggle', () => { - this.toggle(e.open); - }); - } - toggle(e) { - for (let n of this.accordions) n.open = e; - S.setItem(this.key, e.toString()); - } - }, - ie = class extends I { - constructor(e) { - super(e); - let n = this.el.querySelector('summary'), - r = n.querySelector('a'); - r && - r.addEventListener('click', () => { - location.assign(r.href); - }); - let i = `tsd-accordion-${ - n.dataset.key ?? - n.textContent.trim().replace(/\s+/g, '-').toLowerCase() - }`, - s; - if (ue.has(i)) s = ue.get(i); - else { - let o = S.getItem(i), - a = o ? o === 'true' : this.el.open; - (s = new de(i, a)), ue.set(i, s); - } - s.add(this.el); - } - }; - function He(t) { - let e = S.getItem('tsd-theme') || 'os'; - (t.value = e), - Ae(e), - t.addEventListener('change', () => { - S.setItem('tsd-theme', t.value), Ae(t.value); - }); - } - function Ae(t) { - document.documentElement.dataset.theme = t; - } - var se; - function Ne() { - let t = document.getElementById('tsd-nav-script'); - t && (t.addEventListener('load', Re), Re()); - } - async function Re() { - let t = document.getElementById('tsd-nav-container'); - if (!t || !window.navigationData) return; - let e = await R(window.navigationData); - (se = document.documentElement.dataset.base), - se.endsWith('/') || (se += '/'), - (t.innerHTML = ''); - for (let n of e) Be(n, t, []); - window.app.createComponents(t), - window.app.showPage(), - window.app.ensureActivePageVisible(); - } - function Be(t, e, n) { - let r = e.appendChild(document.createElement('li')); - if (t.children) { - let i = [...n, t.text], - s = r.appendChild(document.createElement('details')); - s.className = t.class ? `${t.class} tsd-accordion` : 'tsd-accordion'; - let o = s.appendChild(document.createElement('summary')); - (o.className = 'tsd-accordion-summary'), - (o.dataset.key = i.join('$')), - (o.innerHTML = - ''), - De(t, o); - let a = s.appendChild(document.createElement('div')); - a.className = 'tsd-accordion-details'; - let c = a.appendChild(document.createElement('ul')); - c.className = 'tsd-nested-navigation'; - for (let l of t.children) Be(l, c, i); - } else De(t, r, t.class); - } - function De(t, e, n) { - if (t.path) { - let r = e.appendChild(document.createElement('a')); - if ( - ((r.href = se + t.path), - n && (r.className = n), - location.pathname === r.pathname && - !r.href.includes('#') && - (r.classList.add('current'), (r.ariaCurrent = 'page')), - t.kind) - ) { - let i = window.translations[`kind_${t.kind}`].replaceAll('"', '"'); - r.innerHTML = ``; - } - r.appendChild(Fe(t.text, document.createElement('span'))); - } else { - let r = e.appendChild(document.createElement('span')), - i = window.translations.folder.replaceAll('"', '"'); - (r.innerHTML = ``), - r.appendChild(Fe(t.text, document.createElement('span'))); - } - } - function Fe(t, e) { - let n = t.split( - /(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/ - ); - for (let r = 0; r < n.length; ++r) - r !== 0 && e.appendChild(document.createElement('wbr')), - e.appendChild(document.createTextNode(n[r])); - return e; - } - var oe = document.documentElement.dataset.base; - oe.endsWith('/') || (oe += '/'); - function $e() { - document.querySelector('.tsd-full-hierarchy') - ? ht() - : document.querySelector('.tsd-hierarchy') && pt(); - } - function ht() { - document.addEventListener('click', (r) => { - let i = r.target; - for (; i.parentElement && i.parentElement.tagName != 'LI'; ) - i = i.parentElement; - i.dataset.dropdown && - (i.dataset.dropdown = String(i.dataset.dropdown !== 'true')); - }); - let t = new Map(), - e = new Set(); - for (let r of document.querySelectorAll( - '.tsd-full-hierarchy [data-refl]' - )) { - let i = r.querySelector('ul'); - t.has(r.dataset.refl) - ? e.add(r.dataset.refl) - : i && t.set(r.dataset.refl, i); - } - for (let r of e) n(r); - function n(r) { - let i = t.get(r).cloneNode(!0); - i.querySelectorAll('[id]').forEach((s) => { - s.removeAttribute('id'); - }), - i.querySelectorAll('[data-dropdown]').forEach((s) => { - s.dataset.dropdown = 'false'; - }); - for (let s of document.querySelectorAll(`[data-refl="${r}"]`)) { - let o = gt(), - a = s.querySelector('ul'); - s.insertBefore(o, a), - (o.dataset.dropdown = String(!!a)), - a || s.appendChild(i.cloneNode(!0)); - } - } - } - function pt() { - let t = document.getElementById('tsd-hierarchy-script'); - t && (t.addEventListener('load', Ve), Ve()); - } - async function Ve() { - let t = document.querySelector('.tsd-panel.tsd-hierarchy:has(h4 a)'); - if (!t || !window.hierarchyData) return; - let e = +t.dataset.refl, - n = await R(window.hierarchyData), - r = t.querySelector('ul'), - i = document.createElement('ul'); - if ( - (i.classList.add('tsd-hierarchy'), - ft(i, n, e), - r.querySelectorAll('li').length == i.querySelectorAll('li').length) - ) - return; - let s = document.createElement('span'); - s.classList.add('tsd-hierarchy-toggle'), - (s.textContent = window.translations.hierarchy_expand), - t.querySelector('h4 a')?.insertAdjacentElement('afterend', s), - s.insertAdjacentText('beforebegin', ', '), - s.addEventListener('click', () => { - s.textContent === window.translations.hierarchy_expand - ? (r.insertAdjacentElement('afterend', i), - r.remove(), - (s.textContent = window.translations.hierarchy_collapse)) - : (i.insertAdjacentElement('afterend', r), - i.remove(), - (s.textContent = window.translations.hierarchy_expand)); - }); - } - function ft(t, e, n) { - let r = e.roots.filter((i) => mt(e, i, n)); - for (let i of r) t.appendChild(je(e, i, n)); - } - function je(t, e, n, r = new Set()) { - if (r.has(e)) return; - r.add(e); - let i = t.reflections[e], - s = document.createElement('li'); - if ((s.classList.add('tsd-hierarchy-item'), e === n)) { - let o = s.appendChild(document.createElement('span')); - (o.textContent = i.name), o.classList.add('tsd-hierarchy-target'); - } else { - for (let a of i.uniqueNameParents || []) { - let c = t.reflections[a], - l = s.appendChild(document.createElement('a')); - (l.textContent = c.name), - (l.href = oe + c.url), - (l.className = c.class + ' tsd-signature-type'), - s.append(document.createTextNode('.')); - } - let o = s.appendChild(document.createElement('a')); - (o.textContent = t.reflections[e].name), - (o.href = oe + i.url), - (o.className = i.class + ' tsd-signature-type'); - } - if (i.children) { - let o = s.appendChild(document.createElement('ul')); - o.classList.add('tsd-hierarchy'); - for (let a of i.children) { - let c = je(t, a, n, r); - c && o.appendChild(c); - } - } - return r.delete(e), s; - } - function mt(t, e, n) { - if (e === n) return !0; - let r = new Set(), - i = [t.reflections[e]]; - for (; i.length; ) { - let s = i.pop(); - if (!r.has(s)) { - r.add(s); - for (let o of s.children || []) { - if (o === n) return !0; - i.push(t.reflections[o]); - } - } - } - return !1; - } - function gt() { - let t = document.createElementNS('http://www.w3.org/2000/svg', 'svg'); - return ( - t.setAttribute('width', '20'), - t.setAttribute('height', '20'), - t.setAttribute('viewBox', '0 0 24 24'), - t.setAttribute('fill', 'none'), - (t.innerHTML = ''), - t - ); - } - X(re, 'a[data-toggle]'); - X(ie, '.tsd-accordion'); - X(ee, '.tsd-filter-item input[type=checkbox]'); - var qe = document.getElementById('tsd-theme'); - qe && He(qe); - var yt = new Z(); - Object.defineProperty(window, 'app', { value: yt }); - _e(); - Ne(); - $e(); - 'virtualKeyboard' in navigator && - (navigator.virtualKeyboard.overlaysContent = !0); -})(); +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; +"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=(function(e){return function(n){e.console&&console.warn&&console.warn(n)}})(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}if(s.type===t.QueryLexer.TERM)return t.QueryParser.parseTerm;var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},(function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()})(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function Ee(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function xe(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function Le(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var we=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;Ee(i,{closeOnClick:!0});function a(){xe(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",we+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!Le(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` + ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${we}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Be),Be())}async function Be(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 09b5a1ff..b34bb1d9 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1,2 +1 @@ -window.navigationData = - 'eJytmU1z2zYQhv8Lz07tuE3a+uZRbEczVuSR3fTQ6QECVyImIIACS43VTv97R6RMgfiiAva8L94Hn4sF+cc/BcIrFjfFZ0S1AKxkWVwUimBV3BQgmtpcniI/VFjz4qL4xkRZ3Pzy70XfegVGSWHgZa/AbW/HHIeLgnJiTHFToCnfMfMOXhG0ILywvG/XBjWh+IXs2Jag1CdA2xrMpScZct5f2329bbC6mnEGAu8JRan3AUNPM+bYiWdSbNg27GcrxtxAIKMEmRR3WgdH7Is8z/Nmt8HqoSG6DDPa0FhvDztkLhA0BRVeH1805rmQZcMhbNXFxhyeQe8YjVgcg6MeSDDmcAil2s+kEEAxsoB2NG/l7gFpBQHrYyDP9QEEaEYjvbajef5zsYBa6v2M0Cows4NwHuFRUsKfUWqyhQjFk+SRFhsyqwjnILYQmTBPkk26E1pyXoOI7Shf8z+wuuxnzkHa0nxyHDTJ95EZtHJmckgRbTZ7BX81TEMZJw4U2ZyvoNlmH6dY8UwGM4aJ7Qo2Gkz1Ir9B7HqKKfO4T1I1akYEBc6j0xgQTaAtVXRsw/gExgurQTax4+xJ8khpyHT/3wx8UlJ9kYLGcqAnySaFzXMrH6Wc650dypMNoYcb/hgcWl9/+OiWfU7BZ1v04TGTPtFEfXqFZ3V2kSc1+7stFp+IJrWJohxdHrC/8wadT5BTDSZ24e39kea+qfJg3S14VxPGE4P0VFNgpys3wTqJpqCWqEZH1WumgJ4aU42STqIpqOfajJJ6zRTQV8kojKIsVR7sAbC9Zp8ZB4F8v1SHMxxGRrTTwL8zrI5X4zjZFeehnSdlIhcHlam07DRYyQbhfH9LnoLMneeJZTgPPEvOnZZ52c5x2LeL5Rk/yq1sMLW+A0Vq6Mu1Ab0jaw6LDblVrPs4EvQMS5Pmcn1Kf8n0H1TmTc4S1bnQkDIP2hW97UZLLYsvm4B7lFsmRmm2Kg+2gpJpoHj8UnJLqWxEcvclW0zrxOigQ8LUHu0eY4l7wRZkVn2KtYnoE2yYYIcenUC4V22V6yoc0tWvP7//cB0rV4dfe4+WriDoeF4Fd0iBh3PvMvrABO/BFnlbvBWYhqOHS2gn9wDKo2+E2sfHVmbWGJR1++1vwQSrCV82qBrfN6KbMJLWsXvkv9KKiC14J8Vmh5T59FTS7aijyfa7ae6xtTnBE/sdhOPXW7fY6BCDYD6jLVUIRbbrHuSfiSi5/bruaBFZPnexId1rJJQ5BsFJjAdNBEYQfSyfsJTrWUWEAO76nyL57t3pEKWSLL6lg6J8pvW7y/trsiOaHXLt4KdY8PfJj+5F0W3TEceBKGFI3v5G3VvX2KYRtM0fl1Z4aPLxJ8fEqdXjdp4wYczMOS+Gk39Kn8AoLXesbD+SXIVs7bhn8+d/1kVclQ=='; +window.navigationData = "eJy1m11z3CYUhv+Lrp3GcZu09Z1nkzie8dqetZNcdHqBpbMrJlpQAW2z7fS/d1aSdxGCAwLlmve8zwHxJYT++DdT8F1ll9knpeolqJIX2VlWE1VmlxmwZitfn0p+KtW2ys6yb5QV2eVv/50do1cga84kPO1rMOP1MsPhLMsrImV2mSlZvKLyFXxXIBipMs376lkqQXJ1R3Z0QxQXJ0AbDfL1SDLkvLnQc71qVHm+qCgw9ZHkiou9xXCk8Tl24gVna7qx++kKnxswRXOiKGcfhLDWeCwaeYa1bqPK64aIws5oi3zZHnrIDVMgcqjtz2cs8nkuedFUYLfqynwOjyB2NHdY9IVeD0WUy+FQhMUvOGOQK8cD1EvjntxHUHkJFuu+IM71GhgImjuy1kvj/G/YErZc7BckLy0tOyiOI9zynFSPiguyAQdlJIkjLddkUZKqArYBR4ONJNGkD0zwqtoCc/WosWYGVjf7yRCkLo0nu0FJvrdUKm3ORKvk0EazV/BXQwUUbuJAEc35AoKu926KVh7JoFJStlnBWoAsn/g3cC1PLmUkd3+V57xh6qqmLqApiSM9ECm/wd43qq2yJCIOSve/BoU9L5sqibeCDZUKBM4bqCJ5vG7qBWE5VJVziFlECbT72t2Og/IExhPdAm9cU/1IEkfCIen+nyW8r3l9x1nuGkkjSTTJbh67K65rY+tHD1vXNckPu7++cGh98fad+UpgvAzoFsdin8lxEXL6HBUjq+AXAC7oP+2LxAMRZCudKEMXBzzOmoPkETIWkJjCy7spzn1RxcE+bAmthu9r5ou2BnWqE+CnPdqxSvf1wdne3p6YeRNBn4AvaJZUum3RhAYZBESm0Jq1vkjHH6lSYKctOsI6iVJQ96r21uqoSQE9NLL0kk6iFNTjVnpJR00K6AunOXhRmioOhnSFlA7wsoN8pBUwVaHDyqFNA3+lqux3YX6yKY5DGydbyLJvVWI7ACNgxRsF4f6aHIPcGKckmuGN5XQktFluiraN7b5dWZzxLd/wRmHPd6DAqq6/Nnbns1a/sSwu8/tnCWJHnitYrgmOtEuxumgRYbXCAsJA/WtcKMaUoxD+fFqS0E2CVRn5fFQdCrUp46BBjehtukmo0M0ook9KYCGgtcLGsF2aii0O9SAV+myd6iT4xE24N2ruZEKaZPat+MjXvxnHQ9LSOBxABLWDLkxC3vINZVM6hDVgxhRCqm+PSEricAIOEl3Urcok6CPdsKaeVHVHSHwaf3NRTJqPXQFpKUTMTnjY7Ol4n44nbq6EwmYoJCYykZIzCO8oLnUCfGoXwWPmTQTvHJ6gWVIJ6BZIQGQK7WeN9v0OBY9kCbh27vfSdFUkrJHlHVd03Xff8K4fEDhPSlMHRHD4D0sPHybh8XMnGDB4wmLjEltBzncg9gtehE+xvqD0VCb2r7DQH5IW2q8CY+dMzN+fAuJiEyqogFz197v6cxU8FSQiLQnvZG0TYqcyT1zVwSPEJY6r08Ft4ojAQ2ZNAx0Bnpg5EvH3eEQfl8DnuiDKOvX1r2jWNLxRccl09UE+m+iCOMRXeD6kzR4qotZcbIPHQUhgWkorTraUbSZnhMRFXiaoafvR4T2sKaMHtxNf7ev28oSpMEjnv//65u2F8z60Wave1V+Dzjf4SoTpNrzZ7qaOb7lHkrnwIDtBPKv9tHM4ljcZx4IE78Fa9rLKrEA2lRrhEG1yBlD0vg7qsdzXCxeNVHzbXq1eUka3pLpvVN2MfR26hJq0jt29vO95SWyLns62KePpIUtuRw9eadPo45XWiXcssFF8P3ZOmmM5N5HYKj6Zay6eOsy6bk4g9L8kmJ+uO8SgMJ7RfvgmuaK77ibhJ8KKSr8W2NEcsnjuck26GxO2+XpQmMS4FoQpB+JYFk+458+LkjAGlel/Kol31z8cOHq1RZLMM07rcbJdPFMOIehkYjfzs6Lm1D1hWUVpO5b+T7nRD1c7IuhhHzH4n87659XP5oavmww8jgMRYkhefmT7qG1H1w3L2/Z+rRUPTd79YpgY92vcdiMhYkxlyC2fkz+mRzC14DvaHVWd22z18pHNn/8DRid4+Q==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 5c945503..91b2508b 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1,2 +1 @@ -window.searchData = - 'eJytnFuPm8gSx78Lcx6tZOgbeN5yJnuTkt1o91werGhF7PYYBQMCPLvRKN991YBNFV3gssdPHo27/lXd/auiaWi/BFXxVx08rF6Cr2m+CR7iRZAnexs8BD83TfnRNrtiEyyCQ5UFD4HND/v67fDFm12zz4JFsM6SurZ18BAE3xdHpdCcpN7bzDZ2XuZuc2wE1BZBmVQ2b3A4pI+fbHPGwVPb4jr1n21yZhjudl2T6/Q/Jc16d8ZB2be50kNRnxugsmtypf7hrPzhUnUx0PjuS91Uybr5NXlOn5KmqE7OesG3XotZOnUoTtrrIq+b6rDmq95hE7pPfsiDe3Gvhr7lXQP772//rTJuBEejL98OVXZVDGh4D83u/jFLbd78mLheffPj8JrcZoBpWd4I+1FPDPG6sklju6b8EFqj9dHoihjGQ9y1eyzybfpEhgEb3Gx4PVH24KJ4J4b2ydIj6nudK8BcbzXbW32dt/GU/XRIqg3psv3mZpM0qLFnpwttivgkf7du0ucEXHin/CV5MjR9vb/HXZqdGzLodN23v97zhyLhOMyKmUs05WcMg7tM/ZI3tlrbcmoiR21uBgily0ZlHPjEUKbHJvwIoMk1/sdD/LHYHDIa2e6rmw0okGOPYx/dxPBti+r3oqAHD3rbFlXVtbvA03ig/rDVc7qmR6r/7mZDBfXYY3UMEHThXqiTz6Qs/2iSxv7rvMekLOvmXHU6485WVVExfLXtXuMo3fyn+GrzxyxJ9zXDYbppXPt12/5VjmvXyOZNuk4au+G4rhNo8Trnrgan+RPLbda1fY3D/TY576lrdLWPQ205yLhmF7rBF7Aiz+26ebdeF4e8+X/a7H63m7Sya7qSjJPR2Sad7V9ps6sG2+sjale+P9pmvbOcitA2356aX+33yea2Shr7vizKT1VRbM/7PppsyqIse5NX+HezYOu6TeE/0szmTUbfCo2CcDNg67pN5Xqwu1EkjolPRXkoLw3FAVH2hq+JxU3Ir0XOuNy4ANxc5H3rq73uknyT2WMmPCZZ9iVZfz3vv7M7ZsF6sLs6kqx4StspeDzUTbFvZ+SHv9e7JH9ijEdr7eZh3Vq302IH69dHxQTjFMereTh55pepk/NbVKeseCoOPKfFzJ4Tw1P+9Fv+3tZNVTCKQP5U5JtT46t91hdlW319tnkLymbqXrH95naLyZMafynZhnbFym5wxVjXzTnhrOoGZxes6WadslZ0wO0l67l5x/OrOeiStZabczazyhr8nF9jjVygnKrstrL17pyTodmVfmp01T7nrkaX6ld5/aGn+5y/y7Ng7OmXIxoMb9fBIfTwVOFdf5N4ctZuN2yTtfPXfzf/FAqS1i+W7aZfap9VvTtZJCeLiY4cA51wXdm6LPLa/tl8K8/35m7c/DqnTVLB3dlJb6d2bDdojtxmKt7Shp5O3/LnqaX0U9LsGIJdYS+7xjO7vd4+L3S4m9jXm3HrTFJkcq3z+mtaTi5zZyJwdhctc/2ddTCLox266QklG/LnNsmy4i+7+ZDWJJjT6ne9ZZaeeUrp94LV49+LQ2PZ3QatL+z7u7zIv+2LQ32Fl24MEqDAGgbYtZkMGD3tvyAsZ70/Wt8qpPaq+FvZpEV+1Vi19sXJ/lZhHar0mmg6sxsG8THBuzOXxbJP5jdrWCHBbPrQ3mzNTBdqMJszUPa3L7WtnpMvmf24Td6V6egRLtCnW847QnteuyTLLLyl54nfQUN6MCc6MRGIzasiyy6N4mR1ixDc7tNwJ1FU5ITOReN2ocYCNwrsh7aj+9Pz9mtisyeN7UnjFuE92yrdfrs0oJPVtSGAfDkuJD64DZeZbKTancmVZRRqAVbmaVsU3tttmqfO/uTGrVndEnPc4CL9x6m1eqc+/npWWwq0WO1f1xg/QHtOqtSNMnohhPMkbSTflcl5ddRmVtyA5cPxCfWPw1hvD/m6nby34NtLBEeFflLaa8d1ktaMhdbga64512VZFc/pxrbTSLiAX1OSnxdBmm/s38HDi8vo2rH9EIg38s0yWATb1GYb98pk520RrIv9vrsmbYr1of3zc9/sf7arLg+rrvXb+2Cxul9I80ZEnz8vVkfb9v/tP44Sw39auzBYrMKFCt/IKEaGoWcYIkMRLFaCcCg8O4HsZLBYScqh9AwlMlTBYqUoQ+UZKmSog8VKU4baM9TI0ASLlaEMjWdokGEULFYRZRh5hhEyjIPFKl4I9eZeCmQYe4YxMlwGi9WS8rj0DJd4/h0O4T1JgM9OOIInnIo3JPDB/IQOi5BGz2coxBCFDo1QkMY+RyEGKVSTUfsohZilUE9gH/owhZim0DESkuiHPlAhJip0nIQk/qEPVYipCiexCn2uQgxW6HAJyfQJfbZCDJdo4SJTSPhwCQyXaEsTmUbCp0uMqlNLV0waExUK0yXk1HgJHy6B4RKOl5BMReHTJTBdoqWLTEbh8yUwX8JMRu3jJTBewgEjyGQUPl4C4yUcMYJMRuHzJTBfYjkZtY+XwHhJB4yQRDZKny6J6ZKOF6EoWx8uieGS7bVPU7Y+W3J0+XO4CEPZEhdAzJZ0tIiIsvXRkhgt2aJFJoT00ZIYLeloEUvKsY+WxGhJB4skmZY+WhKjJR0skuRS+mhJjJZ0tEiSS+mzJTFbyuEiyWqtfLgUhks5XiS9WPHpUpgu5YCRZMVVPl4K46Xa5RVZcZXPlxqtsBwykqy4ilhkYcCUQ0aSgCkfMIUBU44ZSVZN5ROmMGHKMaNIwpRPmMKEKceMIglTPmEKE6YcM4okTPmEKUyYdswokjDtE6YxYXpy5aV9wDQGTIup0qd9vjTmS8up0qd9vDTGS6up0qd9uvRoDa+nSp8mVvEYLj1ZvbTPlsZs6ZYtMpO1z5bGbOmWLfrWw2dLY7Z0yxaZydpnS2O2TMsWmcnGZ8tgtkw4dVk1PlsGs2UcLiqmbH22DGbLOFwUWQSMD5fBcBnHiyaLgPHpMpgu094ikkXA+HiZ0V2iI0aTRcAQN4qYL+OI0WQRMD5fBvNlHDGahNP4fBnMl3HEaBJO4/NlMF+RI0aTcEY+XxHmK3LIaPr+2AcswoBFjhlNXmYin7AIExbJiV2SyOcrwnxFLV8knJHPV4T5ihwxhoQz8vmKMF9Ruw1Bwhn5fEWjnQhHjCHhjIjNCMxX5IgxJJyRz1eE+YocMYaEM/L5ijBfsSPGkHDGPl8x5it2xBgSztjnK8Z8xY4YQ8IZ+3zFmK/YMWNIOGOfsBgTFjtmDElY7BMWY8Jix0xEEhb7hMWYsNhMFe3YByzGgMXtXhdJZ+wDFo+2uxwyEUlnTOx4YcBih0xE0hn7gMUYsKVDJiLpXPqALTFgS4dMRNK59AFbYsCWDpmIpHPpA9b/q904frZVYze/dBvIq1WQ9Edw8+Hk8kvwZ7/BHB33rF+CKHh4+f592E5+ePkOdpTdd87l+AWAQUrHQEvwxY5vVAAlA5TueUplWrl9+g14GgR6eT8IxpopeDzyM8gIOcjI+87QhDw5t9ffneTdHs83D8IhiC9kdngQrI9PekCHQ9Bh5sQeml2nt+4fjYD4BIhP8uU8IQ3iMsyJOAlR/QSBxTFb76k7Uws6qEAH+ePV6mwxaoCReMlW8t7mArGBvBLMvPIVR1GC/i75wO37s5EgJQC5gj+hxFQKMJWCP5VekiowAZrXNXT+GAy8BlDwptI/VAzkQFUT7MC6I8NABVRswas94P2QQccAAiJm52aOeg3CEhAheankv+QKphPQb0QnEBuu7PBy/6AIBOPOMgz7T9V/9v8Xsv80/eey+9TMcUc/3wCmEBTBkJfQowNuYLSBluRlzfF3bkBAIB6WxPFdH4ATyJWYB3f/KjioAABJ2U+J5o0PeAcXXGxARTE8ZE4Ho0FUYHQEj2fiSCCYMRCV5CVe+240iAgE1APLq7xTpwRBcKB4Kt40Tp73A6pgYhWPMOL9LQAbqKQxWw8cUwKhAW4VjzX69S0QHajQMU9y6sggiBN0WfFWYN3vQQEJwB1PYHpNooGY4SXFSI1YG4KpMLzEGGm2dwCEMLzJ4eEC3ycehMCVrV/9R7yRHB3HAqkM+iz7ZNZMzeF3L0AlX4LaoHg64zNbIDoAneyvhZqrypubCAzAkjc34FAPCBXMsewv45pXFefPx4L8AS4UbxTGR16BGFiFqAvjJFddYOIV71p3PJ0K1loAcMXL6k7k9JI7qILgKhXxtNofSwBTCoZI8oZo9JtkgxYYHV5lQWdpwQiBxYDiLbeK09uz+22SlKm/HjSgmEY80f6n+EBgIC6eQjHacwF3TTyB7iXGpHvHEWQ0KBpL3uWvxBgCAR7Jx4RoM4RiEUx/zBue00lMMMRgjDWP6NEpOqAFIjK8el/jRWAIoAl5wzQ+7gnCgbPPI7CeWFApkPeKl2vDsVAgAyDQbBny0qBA3Ta8NS19sg0kC0DB8MbreMQRiIBqa3hU4hNFQArgFPGk2uNAIEVAMBGvAMBDPEAIVMiIx2V3tBoUftAb2d96a57U8SQDiAfe7jMy7fMiKNPSZmlug4fV5+/f/wFNk1pT'; +window.searchData = "eJy1nF2PnLgShv8Lcy5bSQO2gbnLmeyXlN2Nds/Zc9GKVqTbPY3CAAJ6dkdR/vuR+azCBV3N9F5NFFxvlcuPC2Nof3XK/K/Kud99db4k2cG5DzdOFj9p5975sa6Ln3V9yg/OxjmXqXPv6Oz8VL0dL7w51U+ps3H2aVxVunLuHefbpldy1SD1Xqe61ssyd4e+EVDbOEVc6qzG4ZA+ftD1BQePTYt16j/q+EIa7k5tk3X6H+N6f7rgoOjarPSQV5cSVLRNVuqfL8qfr1X3Rhrffa7qMt7Xv8TPyWNc5+XgrBN8a7VYpFO63qC9z7OqLs97vuodNqH7ZIc8uve2Yuxb1jbQ/375b5lyI+iNPr+cy3RVDCi95/q0fUgTndXfx6ZXL3YcVpPbJJiW5WXYjnomxftSx7Vum/JDaIz2vdGKGKYpbts95NkxeSTDgA1ull5LlJ1cFO9Mah81nVHb61IB5nqr2N6qdd6mQ/bDOS4PpMvmys0GaVRjj04b2hzxcfZuXyfPMbjxzvmLs3hs+np/D6ckvZQy6HTftV/v+UMecxym+cItmvIzhcHcpn7Kal3udTE3kJM2NwOE0mWjMg18JpVJ34QfATRZ43+a4p/zwzmlkW0v3SyhQI6dxy66mfQd8/K3PKeTB70d87Js213haZqo33X5nOzpTHXXbpYqqMfOVR8g6MLWE4PPuCh+r+Na/+uyx7goqvpSdbrgTpdlXjJ8Ne1e4yg5/Cf/orOHNE6eKobD5FCb9vum/ascV6aRzupkH9f6wHFdxdDidc5NDU6yR5bbtG37GodPx/iyp7bReh8v7/b7/DyzZMSeXuKh6Wp/RVxVXzS99EbexoarfZ0rzZkOptmVbvDNOc8yva+7PP4vqU+/6UNS6j0jp51tl9i/kvpUjrbrI2pW9d/ren/SnGrXND8OzVf7fdSZLuNavy/y4mOZ58fLvnuTQ5EXRWfyCv9mFHRVNeXp9yTVWZ0yWHvUZgR0VTVlqhrtbhSJYeJjXpyLa0MxQBSd4WtiMQPyS54xbqUmADMWWdd6tddTnB1S3c+EhzhNP8f7L5f9t3b9LNiPdqsjSfPHpBmCh3NV50/NiHz39/4UZ4+MfDTWZhz2jXUzLHq0fn1UTDCGOF7Nw+CZX6YG57eoTmn+mJ95TvOF/TSGp+zx1+y9ruoyZxSB7DHPDkPj1T6rq2ZbtX62WYvleu45uLlyu4XyoMZfJjehrVi1jq4Ya9YlJ5wV6+jsivXqolPWahW4vWatuux4eaUKXbLWqUvOFlZZo5/La6yJCzSnSn0sdXW65GRsttJPhe7al9xV6Fb9Kq/fdXRf8nf9LJh6+qlHg+FtHRyeHN+YvOsegAdnzVbKMd4bf9215TdskLRusawP00eWOdW7weLik0sf6IzrUldFnlX6z/qluNybu2nzdU7ruIQ7z7PehnZsN2iMzEYx3q6Hnoar/HFqKP0Y1yeGYFvYi7bxwk62tYcNHZ5m9iwX3BqTBJmsdV59SYrZZe5CBMbuqmWu/dYAjOJk93F+QMmG/LGN0zT/Sx8+JBUJ5rz6XWeZJhfewNq9YPX4t/xca3a3Qesr+/4uy7OXp/xcrfDS5iAGCqw0wK4tzIDJlwxXhGWsn3rrW4XU3BV/Leokz1blqrHPB/tbhXUukzXRtGY3DOLnGO/OXBfLU7y8WcMKCc6mD83D1sJwoQaLcwbK/vq50uVz/DnVPx/jd0UyeT0N9OmWy47QntcpTlMNH+l54nfQkE7mTCdmAtFZmafptVEMVrcIwew+jU8SeUkO6FI0ZhdqKnCjwL5rOvo0fEuwJjY9aBwHjVuE96zL5PhybUCD1doQ6PnSb8xzZ43Vnj932u/SADJJns3fTS767L5zi5HehfvLYscXZ5rB4IE5+WfiHYWuKgYrAv2DQ9jFKPnEsUPEJeOV44/Lxz8z+DMBXyon10XMKizXhMyrefNBXlHv2GGdi0N8y9nf6v0jAJCV8mP7ppBZJ6et+VWy2QRfIX7XG17qu9WRuW2c5DEDrwyuiGSwfE0oYBD6594PpocLi0eq3YXER4Erx03pd0XSrGHf62OSJcZ+cGO2WMyOyLTBVfoPc1tLrfr08qK2D8Iev5ycfsvyHJeJyTT6NpPzUctEvl3VL6ujNoviCjzt9h+LfT/m+njO9s3gvQVXrxGcPJfMSlvtuE6SirEvMPpaas51WZT5c3JoCuiWcAEvU5KfNk6SHfTfzv1XswCtDNv3jvfGfxM5G+eY6PRgfr3Qets4+/zpqS1yh3x/bv75qWv2h25vDve7tvXbrbPZbTd+8EYq+enTZtcbNxea/+g1xv9pDF1ns3M3wnujAoEMXcvQRYaes9l5lEfPMvSQoe9sdj7l0bcMfWQonM1OUIbCMhTIUDqbnaQMpWUokaFyNjtFGSrLUCHDwNnsAsowsAwDZBg6m1248eQb3wuRYWgZhsgwcja7iPIYWYYRBsDw4G5JBGx43Ak97ly8LsEPBsg1WLg0ezZDLobINWi4Hmlsc+RikFwxG7WNkotZcuUc965Nk4txcg0kLsm+axPlYqRcA4pL8u/aVLkYK3eWK9cGy8VkuYYXl5w/rg2Xi+nyGrrIOeTZdHmYLq8pTuQ88my8vEl9avAKSWOiRGG8PH8uX55Nl4fp8gwwLjkXPRsvD+PlNXiRs9Gz+fIwX56ajdrGy8N4eQYYj5yNno2Xh/HyDDEeORs9my8P8+VFs1HbeHkYL98A4/nUdPRtvHyMl2+A8QRpbOPlY7z85v4nSWMbL39yCzTEeIo0Ju6CmC/fEOMFpLHNl4/58hu+yFnh23z5mC/fIOORZPs2YD4GzDfI+CTZvg2YjwHzDTK+S/bZBszHgPmGGZ+k07cJ8zFhwjDjkzVb2IQJTJgwzPj0msUmTGDChGHGJ+uusAkTmDDRrLLIuitswsRkoWWY8cm6K4i1FiZMGGZ8kjBhEyYwYcIw45OECZswgQkThhlBEiZswgQmTBhmBFn/hE2YwIQJw4wgCRM2YQITJg0zgiRM2oRJTJg0zAiSMGkTJjFh0jAj6JWxTZjEhMnZW6S0AZMYMClmK6+0AZOT1bycrbySWNBjwKSarbzSBkxiwGQwW3mlDZjEgMn5EiZtwCQGTDaAkdNZ2oBJDJhqACOns7IBUxgw1QBGTmdlA6YwYKoBjJzOygZMYcCUP3tvVzZhChOmDDOSfCJWNmEKE6aaB0ayFiibMDV5ZjTMSLIWKOKxEROmDDOSrAXKJkxhwpRhRpK1QNmEKUyYMsxIshYomzCFCQsMM5LEM7AJCzBhgWFG0k/LNmEBJiwwzEgSz8AmLMCEBYYZSeIZ2IQFmLDAMKPIu01gExZgwgI5t18T2IAFGLCg2ZUg6QxswILJxoRBRpF0BsTeBAYsMMgoks7ABizAgAUGGUXSGdiABRiw0CCjSDpDG7AQAxYaZBRJZ2gDFmLAQoOMIukMbcBCDFhokFEknaENWIgBCxvASDpDG7AQAxYaZgKSztAmLMSEhYaZgCQstAkLMWFhs/dFEhbahIWT7S/DTEASFhI7YJiw0DATkISFNmEhJiwyzAQkYZFNWIQJiwwzAUlYZBMWYcIiw0xAEhbZhEWYsMgwE5CERTZhESYsMswE9K6hTViECYsMMyFJWGQTFmHComangiQssgmLMGGRYSYkCYtswiJMWNTshJGERTZh0WSTNZpdVUTEPut0o9VAE9I7eFtqq3Wy17ptNlvpjbgtsd26ney3bg06IUlpe21qP9ly3TYrfhLU9trUfrLrum22XUlW22tT+8nO67YhjsS1vTa1b/+veevyrMtaH35q377sdk7cHSWTjSfwfHX+7N7OBP0Ln69O4Nx//fZtfBdz//UbeB1jrhmf0489Rym1BVqCL9Z/PTsqyRAoeTylIinNS64DeJU6Cob+KBiFTMH+p+ujjAdk/G1rqHyenHlR1p5Ic+zP6RmFXZA6d3utYNW/JgUdFlCQr9gK7rsXiyBAD+jxe2wLSZBCxSRuEKI6KmFHXbbgY3s6DOghzBg/sEbniGFTMCQmvuf6ZH28D4IDE8JbrTgJM4Bh8sf0qTvnA0wLQK8n2ULEaHoAM485T43SdKIKQIXk5QudpQMyD/mKrlXqDsgBcoANjzcth+NvgAoYOo/HPPgEEFRsEE3I1Fn4af8o7INx9JlZs37UBIoGAEyJViBiy44/5gTwg463lq7b/e303e7/Pb/7q7q/UftX8mYMPooMDKELuGISig80ANkGNVXwoOrPbAQBgXiukKA/iAPrC0BCyCur/UfjgFPAe8hLFvnxKwgLpCzkFRr7Q1UgB24eIQ/M7kePoPYBDb+DUfKWUeDXZmDSAD3F6+JwvBGICnDh8caPOPwCsAqiEjzQml8BgohAQN1U5d1z5s7DAMGBYi94nM2ebAFUQZUVvKox+6kxQA7EGvEm/fznwEAWBBuxx2f6swowdWGlZXcenB4A8giqgOBNDPpXFSC6CETHliSEAhBbxCNn7kgQ0GGQO8FjvD3LFkiAmsITmF+ESkCc4hW5iRrxOACfP3m4TTSbpz5CGIxswO+6Pc/A0qN74gt4QzE5bgEUMJBHvythkqk5ntkH7tygqx4PYutMBhAdKAB+t/aRiqnKG5sQcG12Pnjaw6/2QayAHr9bt0neTar7eh0EBQY64o3G8iE6YBKCARK8VE7PxQGPNiBOcUVf55bqAtzgBW+Z0B9hA0TATVnwSkMrMvwSFtRksEIIeFrNaXEAC8CXzxtKcAoc0AHj5vPGbXK486gFpHh9Qgf3gEyDii55t/18+P3D0zGOi8R+GFGgIoVXi/apI6UDgFfIy+Eo3Z2WRwvDjPJqyHD4HpiaYDb5vNnUneYOhgSwz1PIJ9udYEh5Au3H93H7bT6oYREsrEwtPJNB9eeNVl9TmiJDTOcQlIaIl+HhxBuQYxCX5E2gyWklIN0AScVLUoUfQVwwCV1emqbH6oCugZuY4k2+amaFLACKkreaGo/fATKgfiq2DHmHFoBIxVsX97/mAgiBAYuY6SaPIQEMAJ4CXtL782iACEBb8eLCxz+AaQe6GPCkln6QCMokGMuItw5uDoUAoYFeBrwJDI9yAEJg1gS8lUZ7wBYo1yBNfrdBJ3lSxKYNqP0how582jhFUug0ybRzv/v07dv/ATa/WzQ="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 200ca34d..44328e99 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,1618 +1,1633 @@ @layer typedoc { - :root { - --dim-toolbar-contents-height: 2.5rem; - --dim-toolbar-border-bottom-width: 1px; - --dim-header-height: calc( - var(--dim-toolbar-border-bottom-width) + - var(--dim-toolbar-contents-height) - ); - - /* 0rem For mobile; unit is required for calculation in `calc` */ - --dim-container-main-margin-y: 0rem; - - --dim-footer-height: 3.5rem; - - --modal-animation-duration: 0.2s; - } - - :root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ - --light-color-background-active: #d6d8da; - --light-color-background-warning: #e6e600; - --light-color-warning-text: #222; - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-background-active); - --light-color-text: #222; - --light-color-contrast-text: #000; - --light-color-text-aside: #5e5e5e; - - --light-color-icon-background: var(--light-color-background); - --light-color-icon-text: var(--light-color-text); - - --light-color-comment-tag-text: var(--light-color-text); - --light-color-comment-tag: var(--light-color-background); - - --light-color-link: #1f70c2; - --light-color-focus-outline: #3584e4; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: #9f5f30; - --light-color-ts-method: #be3989; - --light-color-ts-reference: #ff4d82; - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: #c73c3c; - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - --light-color-document: #000000; - - --light-color-alert-note: #0969d9; - --light-color-alert-tip: #1a7f37; - --light-color-alert-important: #8250df; - --light-color-alert-warning: #9a6700; - --light-color-alert-caution: #cf222e; - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - } - - :root { - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ - --dark-color-background-active: #5d5d6a; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: var(--dark-color-background-active); - --dark-color-text: #f5f5f5; - --dark-color-contrast-text: #ffffff; - --dark-color-text-aside: #dddddd; - - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-icon-text: var(--dark-color-text); - - --dark-color-comment-tag-text: var(--dark-color-text); - --dark-color-comment-tag: var(--dark-color-background); - - --dark-color-link: #00aff4; - --dark-color-focus-outline: #4c97f2; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: #ff984d; - --dark-color-ts-method: #ff4db8; - --dark-color-ts-reference: #ff4d82; - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: #ff6060; - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - --dark-color-document: #ffffff; - - --dark-color-alert-note: #0969d9; - --dark-color-alert-tip: #1a7f37; - --dark-color-alert-important: #8250df; - --dark-color-alert-warning: #9a6700; - --dark-color-alert-caution: #cf222e; - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; - } - - @media (prefers-color-scheme: light) { :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-active: var(--light-color-background-active); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-contrast-text: var(--light-color-contrast-text); - --color-text-aside: var(--light-color-text-aside); - - --color-icon-background: var(--light-color-icon-background); - --color-icon-text: var(--light-color-icon-text); - - --color-comment-tag-text: var(--light-color-text); - --color-comment-tag: var(--light-color-background); - - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-project: var(--light-color-ts-project); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-reference: var(--light-color-ts-reference); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --color-alert-note: var(--light-color-alert-note); - --color-alert-tip: var(--light-color-alert-tip); - --color-alert-important: var(--light-color-alert-important); - --color-alert-warning: var(--light-color-alert-warning); - --color-alert-caution: var(--light-color-alert-caution); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } - } - - @media (prefers-color-scheme: dark) { + --dim-toolbar-contents-height: 2.5rem; + --dim-toolbar-border-bottom-width: 1px; + --dim-header-height: calc( + var(--dim-toolbar-border-bottom-width) + + var(--dim-toolbar-contents-height) + ); + + /* 0rem For mobile; unit is required for calculation in `calc` */ + --dim-container-main-margin-y: 0rem; + + --dim-footer-height: 3.5rem; + + --modal-animation-duration: 0.2s; + } + :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-active: var(--dark-color-background-active); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-contrast-text: var(--dark-color-contrast-text); - --color-text-aside: var(--dark-color-text-aside); - - --color-icon-background: var(--dark-color-icon-background); - --color-icon-text: var(--dark-color-icon-text); - - --color-comment-tag-text: var(--dark-color-text); - --color-comment-tag: var(--dark-color-background); - - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-project: var(--dark-color-ts-project); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-reference: var(--dark-color-ts-reference); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --color-alert-note: var(--dark-color-alert-note); - --color-alert-tip: var(--dark-color-alert-tip); - --color-alert-important: var(--dark-color-alert-important); - --color-alert-warning: var(--dark-color-alert-warning); - --color-alert-caution: var(--dark-color-alert-caution); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } - } - - :root[data-theme='light'] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-active: var(--light-color-background-active); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-contrast-text: var(--light-color-contrast-text); - --color-text-aside: var(--light-color-text-aside); - --color-icon-text: var(--light-color-icon-text); - - --color-comment-tag-text: var(--light-color-text); - --color-comment-tag: var(--light-color-background); - - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-project: var(--light-color-ts-project); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-reference: var(--light-color-ts-reference); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --color-note: var(--light-color-note); - --color-tip: var(--light-color-tip); - --color-important: var(--light-color-important); - --color-warning: var(--light-color-warning); - --color-caution: var(--light-color-caution); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } - - :root[data-theme='dark'] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-active: var(--dark-color-background-active); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-contrast-text: var(--dark-color-contrast-text); - --color-text-aside: var(--dark-color-text-aside); - --color-icon-text: var(--dark-color-icon-text); - - --color-comment-tag-text: var(--dark-color-text); - --color-comment-tag: var(--dark-color-background); - - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-project: var(--dark-color-ts-project); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-reference: var(--dark-color-ts-reference); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --color-note: var(--dark-color-note); - --color-tip: var(--dark-color-tip); - --color-important: var(--dark-color-important); - --color-warning: var(--dark-color-warning); - --color-caution: var(--dark-color-caution); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } - - html { - color-scheme: var(--color-scheme); - @media (prefers-reduced-motion: no-preference) { - scroll-behavior: smooth; - } - } - - *:focus-visible, - .tsd-accordion-summary:focus-visible svg { - outline: 2px solid var(--color-focus-outline); - } - - .always-visible, - .always-visible .tsd-signatures { - display: inherit !important; - } - - h1, - h2, - h3, - h4, - h5, - h6 { - line-height: 1.2; - } - - h1 { - font-size: 1.875rem; - margin: 0.67rem 0; - } - - h2 { - font-size: 1.5rem; - margin: 0.83rem 0; - } - - h3 { - font-size: 1.25rem; - margin: 1rem 0; - } - - h4 { - font-size: 1.05rem; - margin: 1.33rem 0; - } - - h5 { - font-size: 1rem; - margin: 1.5rem 0; - } - - h6 { - font-size: 0.875rem; - margin: 2.33rem 0; - } - - dl, - menu, - ol, - ul { - margin: 1em 0; - } - - dd { - margin: 0 0 0 34px; - } - - .container { - max-width: 1700px; - padding: 0 2rem; - } - - /* Footer */ - footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: var(--dim-footer-height); - } - footer > p { - margin: 0 1em; - } - - .container-main { - margin: var(--dim-container-main-margin-y) auto; - /* toolbar, footer, margin */ - min-height: calc( - 100svh - var(--dim-header-height) - var(--dim-footer-height) - 2 * - var(--dim-container-main-margin-y) - ); - } - - @keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } - } - @keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } - } - @keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } - } - @keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } - } - body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans', - Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji'; - font-size: 16px; - color: var(--color-text); - margin: 0; - } - - a { - color: var(--color-link); - text-decoration: none; - } - a:hover { - text-decoration: underline; - } - a.external[target='_blank'] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; - } - a.tsd-anchor-link { - color: var(--color-text); - } - :target { - scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); - } - - code, - pre { - font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; - } - - pre { - position: relative; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); - margin-bottom: 8px; - } - pre code { - padding: 0; - font-size: 100%; - } - pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; - } - pre:hover > button, - pre > button.visible, - pre > button:focus-visible { - opacity: 1; - } - - blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; - } - - img { - max-width: 100%; - } - - * { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); - } - - *::-webkit-scrollbar { - width: 0.75rem; - } - - *::-webkit-scrollbar-track { - background: var(--color-icon-background); - } - - *::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); - } - - dialog { - border: none; - outline: none; - padding: 0; - background-color: var(--color-background); - } - dialog::backdrop { - display: none; - } - #tsd-overlay { - background-color: rgba(0, 0, 0, 0.5); - position: fixed; - z-index: 9999; - top: 0; - left: 0; - right: 0; - bottom: 0; - animation: fade-in var(--modal-animation-duration) forwards; - } - #tsd-overlay.closing { - animation-name: fade-out; - } - - .tsd-typography { - line-height: 1.333em; - } - .tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; - } - .tsd-typography .tsd-index-panel h3, - .tsd-index-panel .tsd-typography h3, - .tsd-typography h4, - .tsd-typography h5, - .tsd-typography h6 { - font-size: 1em; - } - .tsd-typography h5, - .tsd-typography h6 { - font-weight: normal; - } - .tsd-typography p, - .tsd-typography ul, - .tsd-typography ol { - margin: 1em 0; - } - .tsd-typography table { - border-collapse: collapse; - border: none; - } - .tsd-typography td, - .tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); - } - .tsd-typography thead, - .tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); - } - - .tsd-alert { - padding: 8px 16px; - margin-bottom: 16px; - border-left: 0.25em solid var(--alert-color); - } - .tsd-alert blockquote > :last-child, - .tsd-alert > :last-child { - margin-bottom: 0; - } - .tsd-alert-title { - color: var(--alert-color); - display: inline-flex; - align-items: center; - } - .tsd-alert-title span { - margin-left: 4px; - } - - .tsd-alert-note { - --alert-color: var(--color-alert-note); - } - .tsd-alert-tip { - --alert-color: var(--color-alert-tip); - } - .tsd-alert-important { - --alert-color: var(--color-alert-important); - } - .tsd-alert-warning { - --alert-color: var(--color-alert-warning); - } - .tsd-alert-caution { - --alert-color: var(--color-alert-caution); - } - - .tsd-breadcrumb { - margin: 0; - margin-top: 1rem; - padding: 0; - color: var(--color-text-aside); - } - .tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; - } - .tsd-breadcrumb a:hover { - text-decoration: underline; - } - .tsd-breadcrumb li { - display: inline; - } - .tsd-breadcrumb li:after { - content: ' / '; - } - - .tsd-comment-tags { - display: flex; - flex-direction: column; - } - dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; - } - dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; - } - dl.tsd-comment-tag-group dd { - margin: 0; - } - code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; - } - h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; - } - - dl.tsd-comment-tag-group dd:before, - dl.tsd-comment-tag-group dd:after { - content: ' '; - } - dl.tsd-comment-tag-group dd pre, - dl.tsd-comment-tag-group dd:after { - clear: both; - } - dl.tsd-comment-tag-group p { - margin: 0; - } - - .tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; - } - .tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; - } - - .tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; - } - .tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; - } - .tsd-filter-input { - display: flex; - width: -moz-fit-content; - width: fit-content; - align-items: center; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; - } - .tsd-filter-input input[type='checkbox'] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; - } - .tsd-filter-input input[type='checkbox']:disabled { - pointer-events: none; - } - .tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --light-color-background-active: #d6d8da; + --light-color-background-warning: #e6e600; + --light-color-warning-text: #222; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-background-active); + --light-color-text: #222; + --light-color-contrast-text: #000; + --light-color-text-aside: #5e5e5e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var( + --light-color-ts-constructor + ); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + } + + :root { + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --dark-color-background-active: #5d5d6a; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: var(--dark-color-background-active); + --dark-color-text: #f5f5f5; + --dark-color-contrast-text: #ffffff; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var( + --light-color-background-secondary + ); + --color-background-active: var(--light-color-background-active); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var( + --dark-color-background-secondary + ); + --color-background-active: var(--dark-color-background-active); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + :root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-active: var(--light-color-background-active); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); + --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + + :root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-active: var(--dark-color-background-active); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); + --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + + html { + color-scheme: var(--color-scheme); + @media (prefers-reduced-motion: no-preference) { + scroll-behavior: smooth; + } + } + + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } + + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } + + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } + + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } + + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } + + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } + + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } + + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } + + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } + + dl, + menu, + ol, + ul { + margin: 1em 0; + } + + dd { + margin: 0 0 0 34px; + } + + .container { + max-width: 1700px; + padding: 0 2rem; + } + + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: var(--dim-footer-height); + } + footer > p { + margin: 0 1em; + } + + .container-main { + margin: var(--dim-container-main-margin-y) auto; + /* toolbar, footer, margin */ + min-height: calc( + 100svh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + } + + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: + -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + margin: 0; + } + + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } + :target { + scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); + } + + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } + + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; + } + pre:hover > button, + pre > button.visible, + pre > button:focus-visible { + opacity: 1; + } + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; + } + + img { + max-width: 100%; + } + + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); + } + + *::-webkit-scrollbar { + width: 0.75rem; + } + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); + } + + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); + } + + dialog { + border: none; + outline: none; + padding: 0; + background-color: var(--color-background); + } + dialog::backdrop { + display: none; + } + #tsd-overlay { + background-color: rgba(0, 0, 0, 0.5); + position: fixed; + z-index: 9999; + top: 0; + left: 0; + right: 0; + bottom: 0; + animation: fade-in var(--modal-animation-duration) forwards; + } + #tsd-overlay.closing { + animation-name: fade-out; + } + + .tsd-typography { + line-height: 1.333em; + } + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; + } + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; + } + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; + } + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; + } + .tsd-typography table { + border-collapse: collapse; + border: none; + } + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); + } + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); + } + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); + } + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; + } + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; + } + + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } + + .tsd-breadcrumb { + margin: 0; + margin-top: 1rem; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } + + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } + + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } + + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } + + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. Don't remove unless you know what you're doing. */ - opacity: 0.99; - } - .tsd-filter-input input[type='checkbox']:focus-visible + svg { - outline: 2px solid var(--color-focus-outline); - } - .tsd-checkbox-background { - fill: var(--color-accent); - } - input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); - } - .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; - } - .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); - } - - .settings-label { - font-weight: bold; - text-transform: uppercase; - display: inline-block; - } - - .tsd-filter-visibility .settings-label { - margin: 0.75rem 0 0.5rem 0; - } - - .tsd-theme-toggle .settings-label { - margin: 0.75rem 0.75rem 0 0; - } - - .tsd-hierarchy h4 label:hover span { - text-decoration: underline; - } - - .tsd-hierarchy { - list-style: square; - margin: 0; - } - .tsd-hierarchy-target { - font-weight: bold; - } - .tsd-hierarchy-toggle { - color: var(--color-link); - cursor: pointer; - } - - .tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); - } - .tsd-full-hierarchy, - .tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; - } - .tsd-full-hierarchy ul { - padding-left: 1.5rem; - } - .tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); - } - .tsd-full-hierarchy svg[data-dropdown] { - cursor: pointer; - } - .tsd-full-hierarchy svg[data-dropdown='false'] { - transform: rotate(-90deg); - } - .tsd-full-hierarchy svg[data-dropdown='false'] ~ ul { - display: none; - } - - .tsd-panel-group.tsd-index-group { - margin-bottom: 0; - } - .tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; - } - @media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } + + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } + + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } + + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } + + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } + + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } + + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } + + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; } - } - @media (max-width: 768px) { .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } - } - .tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; - } - - .tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; - } - - .tsd-anchor { - position: relative; - top: -100px; - } - - .tsd-member { - position: relative; - } - .tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; - } - - .tsd-navigation.settings { - margin: 0; - margin-bottom: 1rem; - } - .tsd-navigation > a, - .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; - } - .tsd-navigation a, - .tsd-navigation summary > span, - .tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; - } - .tsd-navigation a.current, - .tsd-page-navigation a.current { - background: var(--color-active-menu-item); - color: var(--color-contrast-text); - } - .tsd-navigation a:hover, - .tsd-page-navigation a:hover { - text-decoration: underline; - } - .tsd-navigation ul, - .tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; - } - .tsd-navigation li, - .tsd-page-navigation li { - padding: 0; - max-width: 100%; - } - .tsd-navigation .tsd-nav-link { - display: none; - } - .tsd-nested-navigation { - margin-left: 3rem; - } - .tsd-nested-navigation > li > details { - margin-left: -1.5rem; - } - .tsd-small-nested-navigation { - margin-left: 1.5rem; - } - .tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; - } - - .tsd-page-navigation-section > summary { - padding: 0.25rem; - } - .tsd-page-navigation-section > summary > svg { - margin-right: 0.25rem; - } - .tsd-page-navigation-section > div { - margin-left: 30px; - } - .tsd-page-navigation ul { - padding-left: 1.75rem; - } - - #tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; - } - #tsd-sidebar-links a:last-of-type { - margin-bottom: 0; - } - - a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); - } - .tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ - display: flex; - align-items: center; - gap: 0.25rem; - box-sizing: border-box; - } - .tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ - } - .tsd-accordion-summary, - .tsd-accordion-summary a { - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - user-select: none; - - cursor: pointer; - } - .tsd-accordion-summary a { - width: calc(100% - 1.5rem); - } - .tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; - } - /* + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } + + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } + + .tsd-anchor { + position: relative; + top: -100px; + } + + .tsd-member { + position: relative; + } + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; + } + + .tsd-navigation.settings { + margin: 0; + margin-bottom: 1rem; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + color: var(--color-contrast-text); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } + + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > summary > svg { + margin-right: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 30px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } + + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } + + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + display: flex; + align-items: center; + gap: 0.25rem; + box-sizing: border-box; + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + /* * We need to be careful to target the arrow indicating whether the accordion * is open, but not any other SVGs included in the details element. */ - .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child { - transform: rotate(-90deg); - } - .tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; - } - .tsd-index-summary { - margin-top: 1.5rem; - margin-bottom: 0.75rem; - display: flex; - align-content: center; - } - - .tsd-no-select { - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - } - .tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; - } - .tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; - } - - .tsd-panel { - margin-bottom: 2.5rem; - } - .tsd-panel.tsd-member { - margin-bottom: 4rem; - } - .tsd-panel:empty { - display: none; - } - .tsd-panel > h1, - .tsd-panel > h2, - .tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; - } - .tsd-panel > h1.tsd-before-signature, - .tsd-panel > h2.tsd-before-signature, - .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; - } - - .tsd-panel-group { - margin: 2rem 0; - } - .tsd-panel-group.tsd-index-group { - margin: 2rem 0; - } - .tsd-panel-group.tsd-index-group details { - margin: 2rem 0; - } - .tsd-panel-group > .tsd-accordion-summary { - margin-bottom: 1rem; - } - - #tsd-search[open] { - animation: fade-in var(--modal-animation-duration) ease-out forwards; - } - #tsd-search[open].closing { - animation-name: fade-out; - } - - /* Avoid setting `display` on closed dialog */ - #tsd-search[open] { - display: flex; - flex-direction: column; - padding: 1rem; - width: 32rem; - max-width: 90vw; - max-height: calc(100vh - env(keyboard-inset-height, 0px) - 25vh); - /* Anchor dialog to top */ - margin-top: 10vh; - border-radius: 6px; - will-change: max-height; - } - #tsd-search-input { - box-sizing: border-box; - width: 100%; - padding: 0 0.625rem; /* 10px */ - outline: 0; - border: 2px solid var(--color-accent); - background-color: transparent; - color: var(--color-text); - border-radius: 4px; - height: 2.5rem; - flex: 0 0 auto; - font-size: 0.875rem; - transition: border-color 0.2s, background-color 0.2s; - } - #tsd-search-input:focus-visible { - background-color: var(--color-background-active); - border-color: transparent; - color: var(--color-contrast-text); - } - #tsd-search-input::placeholder { - color: inherit; - opacity: 0.8; - } - #tsd-search-results { - margin: 0; - padding: 0; - list-style: none; - flex: 1 1 auto; - display: flex; - flex-direction: column; - overflow-y: auto; - } - #tsd-search-results:not(:empty) { - margin-top: 0.5rem; - } - #tsd-search-results > li { - background-color: var(--color-background); - line-height: 1.5; - box-sizing: border-box; - border-radius: 4px; - } - #tsd-search-results > li:nth-child(even) { - background-color: var(--color-background-secondary); - } - #tsd-search-results > li:is(:hover, [aria-selected='true']) { - background-color: var(--color-background-active); - color: var(--color-contrast-text); - } - /* It's important that this takes full size of parent `li`, to capture a click on `li` */ - #tsd-search-results > li > a { - display: flex; - align-items: center; - padding: 0.5rem 0.25rem; - box-sizing: border-box; - width: 100%; - } - #tsd-search-results > li > a > .text { - flex: 1 1 auto; - min-width: 0; - overflow-wrap: anywhere; - } - #tsd-search-results > li > a .parent { - color: var(--color-text-aside); - } - #tsd-search-results > li > a mark { - color: inherit; - background-color: inherit; - font-weight: bold; - } - #tsd-search-status { - flex: 1; - display: grid; - place-content: center; - text-align: center; - overflow-wrap: anywhere; - } - #tsd-search-status:not(:empty) { - min-height: 6rem; - } - - .tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; - font-size: 14px; - overflow-x: auto; - } - - .tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; - } - - .tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; - } - - .tsd-signature-type { - font-style: italic; - font-weight: normal; - } - - .tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; - } - .tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; - } - .tsd-signatures .tsd-index-signature:not(:last-child) { - margin-bottom: 1em; - } - .tsd-signatures .tsd-index-signature .tsd-signature { - border-width: 1px; - } - .tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; - } - - ul.tsd-parameter-list, - ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; - } - ul.tsd-parameter-list > li.tsd-parameter-signature, - ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; - } - ul.tsd-parameter-list h5, - ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; - } - .tsd-sources { - margin-top: 1rem; - font-size: 0.875em; - } - .tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; - } - .tsd-sources ul { - list-style: none; - padding: 0; - } - - .tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: var(--dim-toolbar-border-bottom-width) var(--color-accent) - solid; - transition: transform 0.3s ease-in-out; - } - .tsd-page-toolbar a { - color: var(--color-text); - } - .tsd-toolbar-contents { - display: flex; - align-items: center; - height: var(--dim-toolbar-contents-height); - margin: 0 auto; - } - .tsd-toolbar-contents > .title { - font-weight: bold; - margin-right: auto; - } - #tsd-toolbar-links { - display: flex; - align-items: center; - gap: 1.5rem; - margin-right: 1rem; - } - - .tsd-widget { - box-sizing: border-box; - display: inline-block; - opacity: 0.8; - height: 2.5rem; - width: 2.5rem; - transition: opacity 0.1s, background-color 0.1s; - text-align: center; - cursor: pointer; - border: none; - background-color: transparent; - } - .tsd-widget:hover { - opacity: 0.9; - } - .tsd-widget:active { - opacity: 1; - background-color: var(--color-accent); - } - #tsd-toolbar-menu-trigger { - display: none; - } - - .tsd-member-summary-name { - display: inline-flex; - align-items: center; - padding: 0.25rem; - text-decoration: none; - } - - .tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - color: var(--color-text); - vertical-align: middle; - } - - .tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; - } - - .tsd-member-summary-name:hover > .tsd-anchor-icon svg, - .tsd-anchor-link:hover > .tsd-anchor-icon svg, - .tsd-anchor-icon:focus-visible svg { - visibility: visible; - } - - .deprecated { - text-decoration: line-through !important; - } - - .warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); - } - - .tsd-kind-project { - color: var(--color-ts-project); - } - .tsd-kind-module { - color: var(--color-ts-module); - } - .tsd-kind-namespace { - color: var(--color-ts-namespace); - } - .tsd-kind-enum { - color: var(--color-ts-enum); - } - .tsd-kind-enum-member { - color: var(--color-ts-enum-member); - } - .tsd-kind-variable { - color: var(--color-ts-variable); - } - .tsd-kind-function { - color: var(--color-ts-function); - } - .tsd-kind-class { - color: var(--color-ts-class); - } - .tsd-kind-interface { - color: var(--color-ts-interface); - } - .tsd-kind-constructor { - color: var(--color-ts-constructor); - } - .tsd-kind-property { - color: var(--color-ts-property); - } - .tsd-kind-method { - color: var(--color-ts-method); - } - .tsd-kind-reference { - color: var(--color-ts-reference); - } - .tsd-kind-call-signature { - color: var(--color-ts-call-signature); - } - .tsd-kind-index-signature { - color: var(--color-ts-index-signature); - } - .tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); - } - .tsd-kind-parameter { - color: var(--color-ts-parameter); - } - .tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); - } - .tsd-kind-accessor { - color: var(--color-ts-accessor); - } - .tsd-kind-get-signature { - color: var(--color-ts-get-signature); - } - .tsd-kind-set-signature { - color: var(--color-ts-set-signature); - } - .tsd-kind-type-alias { - color: var(--color-ts-type-alias); - } - - /* if we have a kind icon, don't color the text by kind */ - .tsd-kind-icon ~ span { - color: var(--color-text); - } - - /* mobile */ - @media (max-width: 769px) { - #tsd-toolbar-menu-trigger { - display: inline-block; - /* temporary fix to vertically align, for compatibility */ - line-height: 2.5; + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child { + transform: rotate(-90deg); } - #tsd-toolbar-links { - display: none; + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-summary { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + display: flex; + align-content: center; } - .container-main { - display: flex; + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } + + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; } - .col-content { - float: none; - max-width: 100%; - width: 100%; + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; } - .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; } - .col-sidebar > *:last-child { - padding-bottom: 20px; + + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; } - .overlay { - content: ''; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; } - .to-has-menu .overlay { - animation: fade-in 0.4s; + #tsd-search[open] { + animation: fade-in var(--modal-animation-duration) ease-out forwards; + } + #tsd-search[open].closing { + animation-name: fade-out; } - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; + /* Avoid setting `display` on closed dialog */ + #tsd-search[open] { + display: flex; + flex-direction: column; + padding: 1rem; + width: 32rem; + max-width: 90vw; + max-height: calc(100vh - env(keyboard-inset-height, 0px) - 25vh); + /* Anchor dialog to top */ + margin-top: 10vh; + border-radius: 6px; + will-change: max-height; + } + #tsd-search-input { + box-sizing: border-box; + width: 100%; + padding: 0 0.625rem; /* 10px */ + outline: 0; + border: 2px solid var(--color-accent); + background-color: transparent; + color: var(--color-text); + border-radius: 4px; + height: 2.5rem; + flex: 0 0 auto; + font-size: 0.875rem; + transition: border-color 0.2s, background-color 0.2s; + } + #tsd-search-input:focus-visible { + background-color: var(--color-background-active); + border-color: transparent; + color: var(--color-contrast-text); + } + #tsd-search-input::placeholder { + color: inherit; + opacity: 0.8; + } + #tsd-search-results { + margin: 0; + padding: 0; + list-style: none; + flex: 1 1 auto; + display: flex; + flex-direction: column; + overflow-y: auto; + } + #tsd-search-results:not(:empty) { + margin-top: 0.5rem; + } + #tsd-search-results > li { + background-color: var(--color-background); + line-height: 1.5; + box-sizing: border-box; + border-radius: 4px; + } + #tsd-search-results > li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search-results > li:is(:hover, [aria-selected="true"]) { + background-color: var(--color-background-active); + color: var(--color-contrast-text); + } + /* It's important that this takes full size of parent `li`, to capture a click on `li` */ + #tsd-search-results > li > a { + display: flex; + align-items: center; + padding: 0.5rem 0.25rem; + box-sizing: border-box; + width: 100%; + } + #tsd-search-results > li > a > .text { + flex: 1 1 auto; + min-width: 0; + overflow-wrap: anywhere; + } + #tsd-search-results > li > a .parent { + color: var(--color-text-aside); + } + #tsd-search-results > li > a mark { + color: inherit; + background-color: inherit; + font-weight: bold; + } + #tsd-search-status { + flex: 1; + display: grid; + place-content: center; + text-align: center; + overflow-wrap: anywhere; + } + #tsd-search-status:not(:empty) { + min-height: 6rem; } - .from-has-menu .overlay { - animation: fade-out 0.4s; + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; } - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; } - .has-menu body { - overflow: hidden; + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; } - .has-menu .overlay { - visibility: visible; + + .tsd-signature-type { + font-style: italic; + font-weight: normal; } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; + + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; } - .has-menu .tsd-navigation { - max-height: 100%; + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; } - .tsd-navigation .tsd-nav-link { - display: flex; + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; } - } - /* one sidebar */ - @media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: 'sidebar content'; - --dim-container-main-margin-y: 2rem; + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; } - .tsd-breadcrumb { - margin-top: 0; + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: var(--dim-toolbar-border-bottom-width) + var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + } + .tsd-toolbar-contents { + display: flex; + align-items: center; + height: var(--dim-toolbar-contents-height); + margin: 0 auto; + } + .tsd-toolbar-contents > .title { + font-weight: bold; + margin-right: auto; + } + #tsd-toolbar-links { + display: flex; + align-items: center; + gap: 1.5rem; + margin-right: 1rem; } - .col-sidebar { - grid-area: sidebar; + .tsd-widget { + box-sizing: border-box; + display: inline-block; + opacity: 0.8; + height: 2.5rem; + width: 2.5rem; + transition: opacity 0.1s, background-color 0.1s; + text-align: center; + cursor: pointer; + border: none; + background-color: transparent; } - .col-content { - grid-area: content; - padding: 0 1rem; + .tsd-widget:hover { + opacity: 0.9; } - } - @media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc( - 100vh - var(--dim-header-height) - var(--dim-footer-height) - 2 * - var(--dim-container-main-margin-y) - ); - overflow: auto; - position: sticky; - top: calc(var(--dim-header-height) + var(--dim-container-main-margin-y)); + .tsd-widget:active { + opacity: 1; + background-color: var(--color-accent); } - .site-menu { - margin-top: 1rem; + #tsd-toolbar-menu-trigger { + display: none; } - } - /* two sidebars */ - @media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: 'sidebar content toc'; + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; } - .col-sidebar { - display: contents; + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); + vertical-align: middle; } - .page-menu { - grid-area: toc; - padding-left: 1rem; + .tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; } - .site-menu { - grid-area: sidebar; + + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg, + .tsd-anchor-icon:focus-visible svg { + visibility: visible; + } + + .deprecated { + text-decoration: line-through !important; } - .site-menu { - margin-top: 0rem; + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); + } + + .tsd-kind-project { + color: var(--color-ts-project); + } + .tsd-kind-module { + color: var(--color-ts-module); + } + .tsd-kind-namespace { + color: var(--color-ts-namespace); + } + .tsd-kind-enum { + color: var(--color-ts-enum); + } + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); + } + .tsd-kind-variable { + color: var(--color-ts-variable); + } + .tsd-kind-function { + color: var(--color-ts-function); + } + .tsd-kind-class { + color: var(--color-ts-class); + } + .tsd-kind-interface { + color: var(--color-ts-interface); + } + .tsd-kind-constructor { + color: var(--color-ts-constructor); + } + .tsd-kind-property { + color: var(--color-ts-property); + } + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); + } + + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); + } + + /* mobile */ + @media (max-width: 769px) { + #tsd-toolbar-menu-trigger { + display: inline-block; + /* temporary fix to vertically align, for compatibility */ + line-height: 2.5; + } + #tsd-toolbar-links { + display: none; + } + + .container-main { + display: flex; + } + .col-content { + float: none; + max-width: 100%; + width: 100%; + } + .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + .col-sidebar > *:last-child { + padding-bottom: 20px; + } + .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + --dim-container-main-margin-y: 2rem; + } + + .tsd-breadcrumb { + margin-top: 0; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); + } + .site-menu { + margin-top: 1rem; + } } - .page-menu, - .site-menu { - max-height: calc( - 100vh - var(--dim-header-height) - var(--dim-footer-height) - 2 * - var(--dim-container-main-margin-y) - ); - overflow: auto; - position: sticky; - top: calc(var(--dim-header-height) + var(--dim-container-main-margin-y)); + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: + minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 0rem; + } + + .page-menu, + .site-menu { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); + } } - } } diff --git a/docs/classes/AbstractNavigator.html b/docs/classes/AbstractNavigator.html index e109e69f..c374fb3d 100644 --- a/docs/classes/AbstractNavigator.html +++ b/docs/classes/AbstractNavigator.html @@ -1,557 +1,6 @@ - - - - - - AbstractNavigator | @auth0/auth0-angular - - - - - - - - - - - - -
-
- @auth0/auth0-angular - - - - -
    -
    -
    Preparing search index...
    -
    -     - -
    -
    -
    -
    -
    - -

    Class AbstractNavigator

    -
    - -
    -
    -
    - - -
    Index
    -     -
    -
    -

    Constructors

    -
    - - constructor -
    -
    -
    -

    Methods

    -
    - - navigateByUrl -
    -
    -
    -
    -
    -
    -
    - - -

    Constructors

    -     -
    -
    - - -
    -
    -
    -
    - - -

    Methods

    -     -
    -
    - -
      -
    • - -
      -
      -

      - Navigates to the specified url. The router will be used - if one is available, otherwise it falls back to - window.history.replaceState. -

      -
      -
      -

      Parameters

      -
        -
      • - url: - string -
        -

        The url to navigate to

        -
        -
        • -
      -
      -

      - Returns void -

      - -
      -
      • -
    -
    -
    -
    -
    -
    -
    -
    -
    - - -

    Settings

    -     -
    -
    - Member Visibility -
      -
    • - -
      • -
    • - -
      • -
    • - -
      • -
    -
    -
    - -
    -
    -
    -
    -
    - - -

    On This Page

    -     -
    -
    - - Constructors - - -
    -
    - - Methods - - -
    -
    -
    -
    -
    - -
    -
    -
    -
    -
    - - +AbstractNavigator | @auth0/auth0-angular
    @auth0/auth0-angular
      Preparing search index...

      Class AbstractNavigator

      Index

      Constructors

      constructor +

      Methods

      navigateByUrl +

      Constructors

      Methods

      • Navigates to the specified url. The router will be used if one is available, otherwise it falls back +to window.history.replaceState.

        +

        Parameters

        • url: string

          The url to navigate to

          +

        Returns void

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      diff --git a/docs/classes/Auth0ClientFactory.html b/docs/classes/Auth0ClientFactory.html index 9141d21e..c75fc58d 100644 --- a/docs/classes/Auth0ClientFactory.html +++ b/docs/classes/Auth0ClientFactory.html @@ -1,518 +1,3 @@ - - - - - - Auth0ClientFactory | @auth0/auth0-angular - - - - - - - - - - - - -
      -
      - @auth0/auth0-angular - - - - -
        -
        -
        Preparing search index...
        -
        -         - -
        -
        -
        -
        -
        - -

        Class Auth0ClientFactory

        -
        - -
        -
        -
        - - -
        Index
        -         -
        -
        -

        Constructors

        -
        - - constructor -
        -
        -
        -

        Methods

        -
        - - createClient -
        -
        -
        -
        -
        -
        -
        - - -

        Constructors

        -         -
        -
        - - -
        -
        -
        -
        - - -

        Methods

        -         -
        -
        - - -
        -
        -
        -
        -
        -
        -
        -
        - - -

        Settings

        -         -
        -
        - Member Visibility -
          -
        • - -
          • -
        • - -
          • -
        • - -
          • -
        -
        -
        - -
        -
        -
        -
        -
        - - -

        On This Page

        -         -
        -
        - - Constructors - - -
        -
        - - Methods - - -
        -
        -
        -
        -
        - -
        -
        -
        -
        -
        - - +Auth0ClientFactory | @auth0/auth0-angular
        @auth0/auth0-angular
          Preparing search index...

          Class Auth0ClientFactory

          Index

          Constructors

          constructor +

          Methods

          createClient +

          Constructors

          Methods

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          diff --git a/docs/classes/AuthClientConfig.html b/docs/classes/AuthClientConfig.html index 477d553b..9c3a6dd9 100644 --- a/docs/classes/AuthClientConfig.html +++ b/docs/classes/AuthClientConfig.html @@ -1,649 +1,13 @@ - - - - - - AuthClientConfig | @auth0/auth0-angular - - - - - - - - - - - - -
          -
          - @auth0/auth0-angular - - - - -
            -
            -
            Preparing search index...
            -
            -             - -
            -
            -
            -
            -
            - -

            Class AuthClientConfig

            -
            -
            -
            -

            - Gets and sets configuration for the internal Auth0 client. This - can be used to provide configuration outside of using - AuthModule.forRoot, i.e. from a factory provided by - APP_INITIALIZER. -

            -
            -
            -
            - - 
            // app.module.ts
            // ---------------------------
            import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

            // Provide an initializer function that returns a Promise
            function configInitializer(
              http: HttpClient,
              config: AuthClientConfig
            ) {
              return () =>
                http
                  .get('/config')
                  .toPromise()
                  .then((loadedConfig: any) => config.set(loadedConfig));   // Set the config that was loaded asynchronously here
            }

            // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
            imports: [
              // other imports..

              HttpClientModule,
              AuthModule.forRoot(),   //<- don't pass any config here
            ],
            providers: [
              {
                provide: APP_INITIALIZER,
                useFactory: configInitializer,    // <- pass your initializer function here
                deps: [HttpClient, AuthClientConfig],
                multi: true,
              },
            ],
+AuthClientConfig | @auth0/auth0-angular
            @auth0/auth0-angular
              Preparing search index...
              Class AuthClientConfig
              Gets and sets configuration for the internal Auth0 client. This can be
+used to provide configuration outside of using AuthModule.forRoot, i.e. from
+a factory provided by APP_INITIALIZER.
              
+
              // app.module.ts
              // ---------------------------
              import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

              // Provide an initializer function that returns a Promise
              function configInitializer(
                http: HttpClient,
                config: AuthClientConfig
              ) {
                return () =>
                  http
                    .get('/config')
                    .toPromise()
                    .then((loadedConfig: any) => config.set(loadedConfig));   // Set the config that was loaded asynchronously here
              }

              // Provide APP_INITIALIZER with this function. Note that there is no config passed to AuthModule.forRoot
              imports: [
                // other imports..

                HttpClientModule,
                AuthModule.forRoot(),   //<- don't pass any config here
              ],
              providers: [
                {
                  provide: APP_INITIALIZER,
                  useFactory: configInitializer,    // <- pass your initializer function here
                  deps: [HttpClient, AuthClientConfig],
                  multi: true,
                },
              ],
 
              
-            
              
-          
              
-        
              
-        
-        
              
-          
              
-            
              
-              
-                
-                
              Index
              
-                            
-              
              
-                
              
-                  
              Constructors
              
-                  
              
-                    
-                        constructor
-                  
              
-                
              
-                
              
-                  
              Methods
              
-                  
              
-                    
-                        get
-                    
-                        set
-                  
              
-                
              
-              
              
-            
              
-          
              
-        
              
-        
              
-          
-            
-            
              Constructors
              
-                        
-          
              
-            
              
-              
-              
-            
              
-          
              
-        
              
-        
              
-          
-            
-            
              Methods
              
-                        
-          
              
-            
              
-              
-              
-            
              
-            
              
-              
-              
-            
              
-          
              
-        
              
-      
              
-      
              
-        
              
-          
              
-            
              
-              
-                
-                
              Settings
              
-                            
-              
              
-                
              
-                  Member Visibility
-                  
                
-                    
              • 
-                      
-                    
                • 
-                    
              • 
-                      
-                    
                • 
-                    
              • 
-                      
-                    
                • 
-                  
              
-                
              
-                
              
-                  
-                
              
-              
              
-            
              
-          
              
-          
              
-            
-              
-              
              On This Page
              
-                          
-            
              
-              
              
-                
-                  Constructors
-                
-                
-              
              
-              
              
-                
-                  Methods
-                
-                
-              
              
-            
              
-          
              
-        
              
-        
              
-          
-        
              
-      
              
-    
              
-    
              
-    
              
-  
-
+
+
              Index

              Constructors

              constructor +

              Methods

              get +set +

              Constructors

              Methods

              Settings

              Member Visibility

              On This Page

              Constructors
              Methods
              diff --git a/docs/classes/AuthGuard.html b/docs/classes/AuthGuard.html index 0cf0dcbd..6bf89d97 100644 --- a/docs/classes/AuthGuard.html +++ b/docs/classes/AuthGuard.html @@ -1,761 +1,5 @@ - - - - - - AuthGuard | @auth0/auth0-angular - - - - - - - - - - - - -
              -
              - @auth0/auth0-angular - - - - -
                -
                -
                Preparing search index...
                -
                -                 - -
                -
                -
                -
                -
                - -

                Class AuthGuard

                -
                - -
                -
                -
                - - -
                Index
                -                 -
                -
                -

                Constructors

                -
                - - constructor -
                -
                -
                -

                Methods

                -
                - - canActivate - - canActivateChild - - canLoad -
                -
                -
                -
                -
                -
                -
                - - -

                Constructors

                -                 -
                -
                - - -
                -
                -
                -
                - - -

                Methods

                -                 -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - next: - ActivatedRouteSnapshot -
                    • -
                  • - state: - RouterStateSnapshot -
                    • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                  • -
                -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - childRoute: - ActivatedRouteSnapshot -
                    • -
                  • - state: - RouterStateSnapshot -
                    • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                  • -
                -
                -
                - -
                  -
                • - -
                  -
                  -

                  Parameters

                  -
                    -
                  • - route: - Route -
                    • -
                  • - segments: - UrlSegment[] -
                    • -
                  -
                  -

                  - Returns Observable<boolean> -

                  - -
                  -
                  • -
                -
                -
                -
                -
                -
                -
                -
                -
                - - -

                Settings

                -                 -
                -
                - Member Visibility -
                  -
                • - -
                  • -
                • - -
                  • -
                • - -
                  • -
                -
                -
                - -
                -
                -
                -
                -
                - - -

                On This Page

                -                 -
                -
                - - Constructors - - -
                -
                - - Methods - - -
                -
                -
                -
                -
                - -
                -
                -
                -
                -
                - - +AuthGuard | @auth0/auth0-angular
                @auth0/auth0-angular
                  Preparing search index...

                  Class AuthGuard

                  Index

                  Constructors

                  constructor +

                  Methods

                  canActivate +canActivateChild +canLoad +

                  Constructors

                  Methods

                  • Parameters

                    • next: ActivatedRouteSnapshot
                    • state: RouterStateSnapshot

                    Returns Observable<boolean>

                  • Parameters

                    • childRoute: ActivatedRouteSnapshot
                    • state: RouterStateSnapshot

                    Returns Observable<boolean>

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Methods
                  diff --git a/docs/classes/AuthHttpInterceptor.html b/docs/classes/AuthHttpInterceptor.html index d011d665..7b254d5a 100644 --- a/docs/classes/AuthHttpInterceptor.html +++ b/docs/classes/AuthHttpInterceptor.html @@ -1,645 +1,8 @@ - - - - - - AuthHttpInterceptor | @auth0/auth0-angular - - - - - - - - - - - - -
                  -
                  - @auth0/auth0-angular - - - - -
                    -
                    -
                    Preparing search index...
                    -
                    -                     - -
                    -
                    -
                    -
                    -
                    - -

                    Class AuthHttpInterceptor

                    -
                    -
                    -

                    Implements

                    -
                      -
                    • HttpInterceptor
                      • -
                    -
                    - -
                    -
                    -
                    - - -
                    Index
                    -                     -
                    -
                    -

                    Constructors

                    -
                    - - constructor -
                    -
                    -
                    -

                    Methods

                    -
                    - - intercept -
                    -
                    -
                    -
                    -
                    -
                    -
                    - - -

                    Constructors

                    -                     -
                    -
                    - - -
                    -
                    -
                    -
                    - - -

                    Methods

                    -                     -
                    -
                    - -
                      -
                    • - -
                      -
                      -

                      Identifies and handles a given HTTP request.

                      -
                      -
                      -

                      Parameters

                      -
                        -
                      • - req: - HttpRequest<any> -
                        -

                        The outgoing request object to handle.

                        -
                        -
                        • -
                      • - next: - HttpHandler -
                        -

                        - The next interceptor in the chain, or the backend - if no interceptors remain in the chain. -

                        -
                        -
                        • -
                      -
                      -

                      - Returns Observable<HttpEvent<any>> -

                      -

                      An observable of the event stream.

                      - -
                      -
                      • -
                    -
                    -
                    -
                    -
                    -
                    -
                    -
                    -
                    - - -

                    Settings

                    -                     -
                    -
                    - Member Visibility -
                      -
                    • - -
                      • -
                    • - -
                      • -
                    • - -
                      • -
                    -
                    -
                    - -
                    -
                    -
                    -
                    -
                    - - -

                    On This Page

                    -                     -
                    -
                    - - Constructors - - -
                    -
                    - - Methods - - -
                    -
                    -
                    -
                    -
                    - -
                    -
                    -
                    -
                    -
                    - - +AuthHttpInterceptor | @auth0/auth0-angular
                    @auth0/auth0-angular
                      Preparing search index...

                      Class AuthHttpInterceptor

                      Implements

                      • HttpInterceptor
                      Index

                      Constructors

                      constructor +

                      Methods

                      intercept +

                      Constructors

                      Methods

                      • Identifies and handles a given HTTP request.

                        +

                        Parameters

                        • req: HttpRequest<any>

                          The outgoing request object to handle.

                          +
                        • next: HttpHandler

                          The next interceptor in the chain, or the backend +if no interceptors remain in the chain.

                          +

                        Returns Observable<HttpEvent<any>>

                        An observable of the event stream.

                        +

                      Settings

                      Member Visibility

                      On This Page

                      Constructors
                      Methods
                      diff --git a/docs/classes/AuthModule.html b/docs/classes/AuthModule.html index 8a9a8616..1e96dfb6 100644 --- a/docs/classes/AuthModule.html +++ b/docs/classes/AuthModule.html @@ -1,532 +1,6 @@ - - - - - - AuthModule | @auth0/auth0-angular - - - - - - - - - - - - -
                      -
                      - @auth0/auth0-angular - - - - -
                        -
                        -
                        Preparing search index...
                        -
                        -                         - -
                        -
                        -
                        -
                        -
                        - -

                        Class AuthModule

                        -
                        - -
                        -
                        -
                        - - -
                        Index
                        -                         -
                        -
                        -

                        Constructors

                        -
                        - - constructor -
                        -
                        -
                        -

                        Methods

                        -
                        - - forRoot -
                        -
                        -
                        -
                        -
                        -
                        -
                        - - -

                        Constructors

                        -                         -
                        -
                        - - -
                        -
                        -
                        -
                        - - -

                        Methods

                        -                         -
                        -
                        - -
                          -
                        • - -
                          -
                          -

                          - Initialize the authentication module system. - Configuration can either be specified here, or by - calling AuthClientConfig.set (perhaps from an - APP_INITIALIZER factory function). -

                          -
                          -
                          -

                          Parameters

                          -
                            -
                          • - Optionalconfig: - AuthConfig -
                            -

                            The optional configuration for the SDK.

                            -
                            -
                            • -
                          -
                          -

                          - Returns - ModuleWithProviders<AuthModule> -

                          - -
                          -
                          • -
                        -
                        -
                        -
                        -
                        -
                        -
                        -
                        -
                        - - -

                        Settings

                        -                         -
                        -
                        - Member Visibility -
                          -
                        • - -
                          • -
                        • - -
                          • -
                        • - -
                          • -
                        -
                        -
                        - -
                        -
                        -
                        -
                        -
                        - - -

                        On This Page

                        -                         -
                        -
                        - - Constructors - - -
                        -
                        - - Methods - - -
                        -
                        -
                        -
                        -
                        - -
                        -
                        -
                        -
                        -
                        - - +AuthModule | @auth0/auth0-angular
                        @auth0/auth0-angular
                          Preparing search index...

                          Class AuthModule

                          Index

                          Constructors

                          constructor +

                          Methods

                          forRoot +

                          Constructors

                          Methods

                          Settings

                          Member Visibility

                          On This Page

                          Constructors
                          Methods
                          diff --git a/docs/classes/AuthService.html b/docs/classes/AuthService.html index 68b3a8dc..c8515f27 100644 --- a/docs/classes/AuthService.html +++ b/docs/classes/AuthService.html @@ -1,2847 +1,158 @@ - - - - - - AuthService | @auth0/auth0-angular - - - - - - - - - - - - -
                          -
                          - @auth0/auth0-angular - - - - -
                            -
                            -
                            Preparing search index...
                            -
                            -                             - -
                            -
                            -
                            -
                            -
                            - -

                            Class AuthService<TAppState>

                            -
                            -
                            -

                            Type Parameters

                            - -
                            -
                            -

                            Implements

                            -
                              -
                            • OnDestroy
                              • -
                            -
                            - -
                            -
                            -
                            - - -
                            Index
                            -                             -
                            -
                            -

                            Constructors

                            -
                            - - constructor -
                            -
                            -
                            -

                            Properties

                            -
                            - - appState$ - - error$ - - idTokenClaims$ - - isAuthenticated$ - - isLoading$ - - mfa - - user$ -
                            -
                            -
                            -

                            Methods

                            -
                            - - connectAccountWithRedirect - - createFetcher - - generateDpopProof - - getAccessTokenSilently - - getAccessTokenWithPopup - - getDpopNonce - - handleRedirectCallback - - loginWithCustomTokenExchange - - loginWithPopup - - loginWithRedirect - - logout - - ngOnDestroy - - setDpopNonce -
                            -
                            -
                            -
                            -
                            -
                            -
                            - - -

                            Constructors

                            -                             -
                            -
                            - - -
                            -
                            -
                            -
                            - - -

                            Properties

                            -                             -
                            -
                            - -
                            - appState$: - Observable<TAppState> = ... -
                            -
                            -

                            - Emits the value (if any) that was passed to the - loginWithRedirect method call but only - after handleRedirectCallback is - first called -

                            -
                            - -
                            -
                            - -
                            - error$: - Observable<Error> = ... -
                            -
                            -

                            - Emits errors that occur during login, or when checking for an - active session on startup. -

                            -
                            - -
                            -
                            - -
                            - idTokenClaims$: - Observable<IdToken - | - null - | - undefined> = ... -
                            -
                            -

                            - Emits ID token claims when authenticated, or null if not - authenticated. -

                            -
                            - -
                            -
                            - -
                            - isAuthenticated$: - Observable<boolean> = ... -
                            -
                            -

                            - Emits boolean values indicating the authentication state of - the user. If true, it means a user has - authenticated. This depends on the value of - isLoading$, so there is no need to manually check - the loading state of the SDK. -

                            -
                            - -
                            -
                            - -
                            - isLoading$: - Observable<boolean> = ... -
                            -
                            -

                            - Emits boolean values indicating the loading state of the SDK. -

                            -
                            - -
                            -
                            - -
                            - mfa: - ObservableMfaApiClient = ... -
                            -
                            -

                            - Provides MFA (Multi-Factor Authentication) operations as - Observables. -

                            -

                            - These methods are available after - getAccessTokenSilently throws an - MfaRequiredError. Use the - mfa_token from the error to call these methods. -

                            -
                            - -
                            -
                            - -
                            - user$: - Observable<User - | - null - | - undefined> = ... -
                            -
                            -

                            - Emits details about the authenticated user, or null if not - authenticated. -

                            -
                            - -
                            -
                            -
                            -
                            - - -

                            Methods

                            -                             -
                            -
                            - -
                              -
                            • - -
                              -
                              - 
                              connectAccountWithRedirect({
                                connection: 'google-oauth2',
                                scopes: ['openid', 'profile', 'email', 'https://www.googleapis.com/auth/drive.readonly'],
                                authorization_params: {
                                  // additional authorization params to forward to the authorization server
                                }
                              });
+AuthService | @auth0/auth0-angular
                              @auth0/auth0-angular
                                Preparing search index...
                                Class AuthService<TAppState>
                                Type Parameters
                                Implements
                                • OnDestroy
                                Index
                                Constructors
                                constructor
+
                                Properties
                                appState$
+error$
+idTokenClaims$
+isAuthenticated$
+isLoading$
+mfa
+myAccount
+passkey
+user$
+
                                Methods
                                connectAccountWithRedirect
+createFetcher
+generateDpopProof
+getAccessTokenSilently
+getAccessTokenWithPopup
+getDpopNonce
+handleRedirectCallback
+loginWithCustomTokenExchange
+loginWithPopup
+loginWithRedirect
+logout
+ngOnDestroy
+setDpopNonce
+
                                Constructors
                                Properties
                                appState$: Observable<TAppState> = ...
                                Emits the value (if any) that was passed to the loginWithRedirect method call
+but only after handleRedirectCallback is first called
                                
+
                                error$: Observable<Error> = ...
                                Emits errors that occur during login, or when checking for an active session on startup.
                                
+
                                idTokenClaims$: Observable<IdToken | null | undefined> = ...
                                Emits ID token claims when authenticated, or null if not authenticated.
                                
+
                                isAuthenticated$: Observable<boolean> = ...
                                Emits boolean values indicating the authentication state of the user. If true, it means a user has authenticated.
+This depends on the value of isLoading$, so there is no need to manually check the loading state of the SDK.
                                
+
                                isLoading$: Observable<boolean> = ...
                                Emits boolean values indicating the loading state of the SDK.
                                
+
                                mfa: ObservableMfaApiClient = ...
                                Provides MFA (Multi-Factor Authentication) operations as Observables.
                                
+
                                These methods are available after getAccessTokenSilently throws an MfaRequiredError.
+Use the mfa_token from the error to call these methods.
                                
+
                                myAccount: ObservableMyAccountApiClient = ...
                                Provides MyAccount API operations as Observables.
                                
+
                                Allows the authenticated user to list, enroll, update, and delete their
+authentication methods. Requires an access token with the appropriate
+read/create/update/delete:me:authentication-methods scopes.
                                
+
                                passkey: ObservablePasskeyApiClient = ...
                                Provides Passkey (WebAuthn) authentication as Observables.
                                
+
                                Both methods handle the full WebAuthn challenge-response flow internally.
+After a successful call, this updates the authentication state to ensure
+consistency with the standard authentication flows.
                                
+
                                user$: Observable<User | null | undefined> = ...
                                Emits details about the authenticated user, or null if not authenticated.
                                
+
                                Methods
                                • connectAccountWithRedirect({
                                    connection: 'google-oauth2',
                                    scopes: ['openid', 'profile', 'email', 'https://www.googleapis.com/auth/drive.readonly'],
                                    authorization_params: {
                                      // additional authorization params to forward to the authorization server
                                    }
                                  });
 
                                  
 
-                      
                                  
-                        Redirects to the /connect URL using the
-                        parameters provided as arguments. This then redirects to
-                        the connection's login page where the user can
-                        authenticate and authorize the account to be connected.
-                      
                                  
-                      
                                  
-                        If connecting the account is successful,
-                        handleRedirectCallback will be called with
-                        the details of the connected account.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  generateDpopProof(params).subscribe(proof => ...)
+
                                  Creates a custom fetcher instance that can be used to make authenticated
+HTTP requests. The fetcher automatically handles token refresh and can
+be configured with custom request/response handling.
                                  
+
                                  Type Parameters
                                  Parameters
                                  Returns Fetcher<TOutput>
                                  A Fetcher instance configured with the Auth0 client.
                                  
+
                                • generateDpopProof(params).subscribe(proof => ...)
 
                                  
 
-                      
                                  
-                        Generates a DPoP (Demonstrating Proof-of-Possession)
-                        proof JWT. This proof is used to bind access tokens to a
-                        specific client, providing an additional layer of
-                        security for token usage.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          params:
-                            {
-                            accessToken:
-                            string;
-                            method:
-                            string;
-                            nonce?:
-                            string;
-                            url:
-                            string
-                            }
-                          
                                    
-                            
                                    Configuration for generating the DPoP proof
                                    
-                          
                                    
-                          
                                      
-                            
                                    • 
-                              
                                      
-                                accessToken: string
-                              
                                      
-                              
                                      
-                                
                                      The access token to bind to the proof
                                      
-                              
                                      
-                            
                                      • 
-                            
                                    • 
-                              
                                      
-                                method: string
-                              
                                      
-                              
                                      
-                                
                                      The HTTP method (e.g., 'GET', 'POST')
                                      
-                              
                                      
-                            
                                      • 
-                            
                                    • 
-                              
                                      
-                                Optionalnonce?: string
-                              
                                      
-                              
                                      
-                                
                                      
-                                  Optional DPoP nonce from the authorization
-                                  server
-                                
                                      
-                              
                                      
-                            
                                      • 
-                            
                                    • 
-                              
                                      
-                                url: string
-                              
                                      
-                              
                                      
-                                
                                      The URL of the resource server endpoint
                                      
-                              
                                      
-                            
                                      • 
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<string>
-                    
                                  
-                    
                                  
-                      An Observable that emits the generated DPoP proof as a JWT
-                      string.
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  getTokenWithPopup(options).subscribe(token => ...)
+
                                  Generates a DPoP (Demonstrating Proof-of-Possession) proof JWT.
+This proof is used to bind access tokens to a specific client, providing
+an additional layer of security for token usage.
                                  
+
                                  Parameters
                                  • params: { accessToken: string; method: string; nonce?: string; url: string }
                                    Configuration for generating the DPoP proof
                                    
+
                                    • accessToken: string
                                      The access token to bind to the proof
                                      
+
                                    • method: string
                                      The HTTP method (e.g., 'GET', 'POST')
                                      
+
                                    • Optionalnonce?: string
                                      Optional DPoP nonce from the authorization server
                                      
+
                                    • url: string
                                      The URL of the resource server endpoint
                                      
+
                                  Returns Observable<string>
                                  An Observable that emits the generated DPoP proof as a JWT string.
                                  
+
                                • getTokenWithPopup(options).subscribe(token => ...)
 
                                  
 
-                      
                                  Get an access token interactively.
                                  
-                      
                                  
-                        Opens a popup with the /authorize URL using
-                        the parameters provided as arguments. Random and secure
-                        state and nonce parameters
-                        will be auto-generated. If the response is successful,
-                        results will be valid according to their expiration
-                        times.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<string
-                      |
-                      undefined>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  getDpopNonce(id).subscribe(nonce => ...)
+
                                  Get an access token interactively.
                                  
+
                                  Opens a popup with the /authorize URL using the parameters
+provided as arguments. Random and secure state and nonce
+parameters will be auto-generated. If the response is successful,
+results will be valid according to their expiration times.
                                  
+
                                  Parameters
                                  Returns Observable<string | undefined>
                                • getDpopNonce(id).subscribe(nonce => ...)
 
                                  
 
-                      
                                  
-                        Gets the DPoP nonce for the specified domain or the
-                        default domain. The nonce is used in DPoP proof
-                        generation for token binding.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          Optionalid:
-                            string
-                          
                                    
-                            
                                    
-                              Optional identifier for the domain. If not
-                              provided, uses the default domain.
-                            
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<string
-                      |
-                      undefined>
-                    
                                  
-                    
                                  
-                      An Observable that emits the DPoP nonce string or
-                      undefined if not available.
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  handleRedirectCallback(url).subscribe(result => ...)
+
                                  Gets the DPoP nonce for the specified domain or the default domain.
+The nonce is used in DPoP proof generation for token binding.
                                  
+
                                  Parameters
                                  • Optionalid: string
                                    Optional identifier for the domain. If not provided, uses the default domain.
                                    
+
                                  Returns Observable<string | undefined>
                                  An Observable that emits the DPoP nonce string or undefined if not available.
                                  
+
                                • handleRedirectCallback(url).subscribe(result => ...)
 
                                  
 
-                      
                                  
-                        After the browser redirects back to the callback page,
-                        call handleRedirectCallback to handle
-                        success and error responses from Auth0. If the response
-                        is successful, results will be valid according to their
-                        expiration times.
-                      
                                  
-                      
                                  
-                        Calling this method also refreshes the authentication
-                        and user states.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          Optionalurl:
-                            string
-                          
                                    
-                            
                                    
-                              The URL to that should be used to retrieve the
-                              state and code values.
-                              Defaults to window.location.href if
-                              not given.
-                            
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<
                                      RedirectLoginResult<TAppState>
                                      |
-                      ConnectAccountRedirectResult<TAppState>,
                                  >
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  loginWithCustomTokenExchange(options).subscribe(tokenResponse => ...)
+
                                  After the browser redirects back to the callback page,
+call handleRedirectCallback to handle success and error
+responses from Auth0. If the response is successful, results
+will be valid according to their expiration times.
                                  
+
                                  Calling this method also refreshes the authentication and user states.
                                  
+
                                  Parameters
                                  • Optionalurl: string
                                    The URL to that should be used to retrieve the state and code values. Defaults to window.location.href if not given.
                                    
+
                                  Returns Observable<
                                      RedirectLoginResult<TAppState>
                                      | ConnectAccountRedirectResult<TAppState>,
                                  >
                                • loginWithCustomTokenExchange(options).subscribe(tokenResponse => ...)
 
                                  
 
-                      
                                  
-                        Exchanges an external subject token for Auth0 tokens and
-                        establishes an authenticated session.
-                      
                                  
-                      
                                  
-                        This method implements the token exchange grant as
-                        specified in RFC 8693. It performs a token exchange by
-                        sending a request to the
-                        /oauth/token endpoint with the external
-                        token and returns Auth0 tokens (access token, ID token,
-                        etc.).
-                      
                                  
-                      
                                  The request includes the following parameters:
                                  
-                      
                                    
-                        
                                  • 
-                          grant_type: Hard-coded to
-                          "urn:ietf:params:oauth:grant-type:token-exchange"
-                        
                                    • 
-                        
                                  • 
-                          subject_token: The external token to be
-                          exchanged
-                        
                                    • 
-                        
                                  • 
-                          subject_token_type: A namespaced URI
-                          identifying the token type (must be under your
-                          organization's control)
-                        
                                    • 
-                        
                                  • 
-                          audience: The target audience (falls back
-                          to the SDK's default audience if not provided)
-                        
                                    • 
-                        
                                  • 
-                          scope: Space-separated list of scopes
-                          (merged with the SDK's default scopes)
-                        
                                    • 
-                      
                                  
-                      
                                  
-                        After a successful token exchange, this method updates
-                        the authentication state to ensure consistency with the
-                        standard authentication flows.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<TokenEndpointResponse>
-                    
                                  
-                    
                                  
-                      An Observable that emits the token endpoint response
-                      containing Auth0 tokens
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  await loginWithPopup(options);
+
                                  Exchanges an external subject token for Auth0 tokens and establishes an authenticated session.
                                  
+
                                  This method implements the token exchange grant as specified in RFC 8693.
+It performs a token exchange by sending a request to the /oauth/token endpoint
+with the external token and returns Auth0 tokens (access token, ID token, etc.).
                                  
+
                                  The request includes the following parameters:
                                  
+
                                    
+
                                  • grant_type: Hard-coded to "urn:ietf:params:oauth:grant-type:token-exchange"
                                    • 
+
                                  • subject_token: The external token to be exchanged
                                    • 
+
                                  • subject_token_type: A namespaced URI identifying the token type (must be under your organization's control)
                                    • 
+
                                  • audience: The target audience (falls back to the SDK's default audience if not provided)
                                    • 
+
                                  • scope: Space-separated list of scopes (merged with the SDK's default scopes)
                                    • 
+
                                  
+
                                  After a successful token exchange, this method updates the authentication state
+to ensure consistency with the standard authentication flows.
                                  
+
                                  Parameters
                                  Returns Observable<TokenEndpointResponse>
                                  An Observable that emits the token endpoint response containing Auth0 tokens
                                  
+
                                • await loginWithPopup(options);
 
                                  
 
-                      
                                  
-                        Opens a popup with the /authorize URL using
-                        the parameters provided as arguments. Random and secure
-                        state and nonce parameters
-                        will be auto-generated. If the response is successful,
-                        results will be valid according to their expiration
-                        times.
-                      
                                  
-                      
                                  
-                        IMPORTANT: This method has to be called from an event
-                        handler that was started by the user like a button
-                        click, for example, otherwise the popup will be blocked
-                        in most browsers.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  loginWithRedirect(options);
+
                                  Opens a popup with the /authorize URL using the parameters
+provided as arguments. Random and secure state and nonce
+parameters will be auto-generated. If the response is successful,
+results will be valid according to their expiration times.
                                  
+
                                  IMPORTANT: This method has to be called from an event handler
+that was started by the user like a button click, for example,
+otherwise the popup will be blocked in most browsers.
                                  
+
                                  Parameters
                                  Returns Observable<void>
                                
-            
                                
-            
                                
-              
-              
                                • logout();
 
                                  
 
-                      
                                  
-                        Clears the application session and performs a redirect
-                        to /v2/logout, using the parameters
-                        provided as arguments, to clear the Auth0 session. If
-                        the federated option is specified it also
-                        clears the Identity Provider session. If the
-                        openUrl option is set to false, it only
-                        clears the application session. It is invalid to set
-                        both the federated to true and
-                        openUrl to false, and an error
-                        will be thrown if you do.
-                        Read more about how Logout works at Auth0.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          Optionaloptions:
-                            LogoutOptions
-                          
                                    
-                            
                                    The logout options
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-            
                                
-              
-              
-            
                                
-            
                                
-              
-              
                                  
-                
                                • 
-                  
-                  
                                  
-                    
                                  
-                      
                                  setDpopNonce(nonce, id).subscribe(() => ...)
+
                                  Clears the application session and performs a redirect to /v2/logout, using
+the parameters provided as arguments, to clear the Auth0 session.
+If the federated option is specified it also clears the Identity Provider session.
+If the openUrl option is set to false, it only clears the application session.
+It is invalid to set both the federated to true and openUrl to false,
+and an error will be thrown if you do.
+Read more about how Logout works at Auth0.
                                  
+
                                  Parameters
                                  Returns Observable<void>
                                • setDpopNonce(nonce, id).subscribe(() => ...)
 
                                  
 
-                      
                                  
-                        Sets the DPoP nonce for the specified domain or the
-                        default domain. This is typically used after receiving a
-                        new nonce from the authorization server.
-                      
                                  
-                    
                                  
-                    
                                  
-                      
                                  Parameters
                                  
-                      
                                    
-                        
                                  • 
-                          nonce:
-                            string
-                          
                                    
-                            
                                    The DPoP nonce value to set.
                                    
-                          
                                    
-                        
                                    • 
-                        
                                  • 
-                          Optionalid:
-                            string
-                          
                                    
-                            
                                    
-                              Optional identifier for the domain. If not
-                              provided, uses the default domain.
-                            
                                    
-                          
                                    
-                        
                                    • 
-                      
                                  
-                    
                                  
-                    
                                  
-                      Returns Observable<void>
-                    
                                  
-                    
                                  An Observable that completes when the nonce is set.
                                  
-                    
-                  
                                  
-                
                                  • 
-              
                                
-            
                                
-          
                                
-        
                                
-      
                                
-      
                                
-        
                                
-          
                                
-            
                                
-              
-                
-                
                                Settings
                                
-                                              
-              
                                
-                
                                
-                  Member Visibility
-                  
                                  
-                    
                                • 
-                      
-                    
                                  • 
-                    
                                • 
-                      
-                    
                                  • 
-                    
                                • 
-                      
-                    
                                  • 
-                  
                                
-                
                                
-                
                                
-                  
-                
                                
-              
                                
-            
                                
-          
                                
-          
                                
-            
-              
-              
                                On This Page
                                
-                                            
-            
                                
-              
                                
-                
-                  Constructors
-                
-                
-              
                                
-              
                                
-                
-                  Properties
-                
-                
-              
                                
-              
                                
-                
-                  Methods
-                
-                
-              
                                
-            
                                
-          
                                
-        
                                
-        
                                
-          
-        
                                
-      
                                
-    
                                
-    
                                
-    
                                
-  
-
+
                                Sets the DPoP nonce for the specified domain or the default domain.
+This is typically used after receiving a new nonce from the authorization server.
                                
+

                                Parameters

                                • nonce: string

                                  The DPoP nonce value to set.

                                  +
                                • Optionalid: string

                                  Optional identifier for the domain. If not provided, uses the default domain.

                                  +

                                Returns Observable<void>

                                An Observable that completes when the nonce is set.

                                +

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              diff --git a/docs/classes/AuthState.html b/docs/classes/AuthState.html index fa5a59e7..921e6988 100644 --- a/docs/classes/AuthState.html +++ b/docs/classes/AuthState.html @@ -1,1121 +1,26 @@ - - - - - - AuthState | @auth0/auth0-angular - - - - - - - - - - - - -
                              -
                              - @auth0/auth0-angular - - - - -
                                -
                                -
                                Preparing search index...
                                -
                                -                                 - -
                                -
                                -
                                -
                                -
                                - -

                                Class AuthState

                                -
                                -
                                -
                                -

                                Tracks the Authentication State for the SDK

                                -
                                -
                                - -
                                -
                                -
                                - - -
                                Index
                                -                                 -
                                -
                                -

                                Constructors

                                -
                                - - constructor -
                                -
                                -
                                -

                                Properties

                                -
                                - - error$ - - idTokenClaims$ - - isAuthenticated$ - - isLoading$ - - user$ -
                                -
                                -
                                -

                                Methods

                                -
                                - - refresh - - setAccessToken - - setError - - setIsLoading -
                                -
                                -
                                -
                                -
                                -
                                -
                                - - -

                                Constructors

                                -                                 -
                                -
                                - - -
                                -
                                -
                                -
                                - - -

                                Properties

                                -                                 -
                                -
                                - -
                                - error$: - Observable<Error> = ... -
                                -
                                -

                                - Emits errors that occur during login, or when checking for an - active session on startup. -

                                -
                                - -
                                -
                                - -
                                - idTokenClaims$: - Observable<IdToken - | - null - | - undefined> = ... -
                                -
                                -

                                - Emits ID token claims when authenticated, or null if not - authenticated. -

                                -
                                - -
                                -
                                - -
                                - isAuthenticated$: - Observable<boolean> = ... -
                                -
                                -

                                - Emits boolean values indicating the authentication state of - the user. If true, it means a user has - authenticated. This depends on the value of - isLoading$, so there is no need to manually check - the loading state of the SDK. -

                                -
                                - -
                                -
                                - -
                                - isLoading$: - Observable<boolean> = ... -
                                -
                                -

                                - Emits boolean values indicating the loading state of the SDK. -

                                -
                                - -
                                -
                                - -
                                - user$: - Observable<User - | - null - | - undefined> = ... -
                                -
                                -

                                - Emits details about the authenticated user, or null if not - authenticated. -

                                -
                                - -
                                -
                                -
                                -
                                - - -

                                Methods

                                -                                 -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Refresh the state to ensure the - isAuthenticated, user$ and - idTokenClaims$ reflect the most up-to-date - values from Auth0Client. -

                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Update the access token, doing so will also refresh the - state. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - accessToken: - string -
                                    -

                                    The new Access Token

                                    -
                                    -
                                    • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  - Emits the error in the error$ observable. -

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - error: - any -
                                    -

                                    The new error

                                    -
                                    -
                                    • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                - -
                                  -
                                • - -
                                  -
                                  -

                                  Update the isLoading state using the provided value

                                  -
                                  -
                                  -

                                  Parameters

                                  -
                                    -
                                  • - isLoading: - boolean -
                                    -

                                    The new value for isLoading

                                    -
                                    -
                                    • -
                                  -
                                  -

                                  - Returns void -

                                  - -
                                  -
                                  • -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                -
                                - - -

                                Settings

                                -                                 -
                                -
                                - Member Visibility -
                                  -
                                • - -
                                  • -
                                • - -
                                  • -
                                • - -
                                  • -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -
                                - - -

                                On This Page

                                -                                 -
                                -
                                - - Constructors - - -
                                -
                                - - Properties - - -
                                -
                                - - Methods - - -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -
                                - - +AuthState | @auth0/auth0-angular
                                @auth0/auth0-angular
                                  Preparing search index...

                                  Class AuthState

                                  Tracks the Authentication State for the SDK

                                  +
                                  Index

                                  Constructors

                                  constructor +

                                  Properties

                                  error$ +idTokenClaims$ +isAuthenticated$ +isLoading$ +user$ +

                                  Methods

                                  refresh +setAccessToken +setError +setIsLoading +

                                  Constructors

                                  Properties

                                  error$: Observable<Error> = ...

                                  Emits errors that occur during login, or when checking for an active session on startup.

                                  +
                                  idTokenClaims$: Observable<IdToken | null | undefined> = ...

                                  Emits ID token claims when authenticated, or null if not authenticated.

                                  +
                                  isAuthenticated$: Observable<boolean> = ...

                                  Emits boolean values indicating the authentication state of the user. If true, it means a user has authenticated. +This depends on the value of isLoading$, so there is no need to manually check the loading state of the SDK.

                                  +
                                  isLoading$: Observable<boolean> = ...

                                  Emits boolean values indicating the loading state of the SDK.

                                  +
                                  user$: Observable<User | null | undefined> = ...

                                  Emits details about the authenticated user, or null if not authenticated.

                                  +

                                  Methods

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Constructors
                                  Properties
                                  Methods
                                  diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index cc4aa971..b7cf8bf0 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,1345 +1,39 @@ - - - - - - AuthenticationError | @auth0/auth0-angular - - - - - - - - - - - - -
                                  -
                                  - @auth0/auth0-angular - - - - -
                                    -
                                    -
                                    Preparing search index...
                                    -
                                    -                                     - -
                                    -
                                    -
                                    -
                                    -
                                    - -

                                    Class AuthenticationError

                                    -
                                    -
                                    -
                                    -

                                    - Thrown when handling the redirect callback fails, will be one of - Auth0's Authentication API's Standard Error Responses: - https://auth0.com/docs/api/authentication?javascript#standard-error-responses -

                                    -
                                    -
                                    -
                                    -

                                    - Hierarchy (View Summary) -

                                    - -
                                    - -
                                    -
                                    -
                                    - - -
                                    Index
                                    -                                     -
                                    -
                                    -

                                    Constructors

                                    -
                                    - - constructor -
                                    -
                                    -
                                    -

                                    Properties

                                    -
                                    - - appState - - error - - error_description - - message - - name - - stack? - - state - - stackTraceLimit -
                                    -
                                    -
                                    -

                                    Methods

                                    -
                                    - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - - -

                                    Constructors

                                    -                                     -
                                    -
                                    - -
                                      -
                                    • - -
                                      -
                                      -

                                      Parameters

                                      -
                                        -
                                      • - error: - string -
                                        • -
                                      • - error_description: - string -
                                        • -
                                      • - state: - string -
                                        • -
                                      • - OptionalappState: - any -
                                        • -
                                      -
                                      -

                                      - Returns - AuthenticationError -

                                      - -
                                      -
                                      • -
                                    -
                                    -
                                    -
                                    -
                                    - - -

                                    Properties

                                    -                                     -
                                    -
                                    - -
                                    - appState: - any -
                                    - -
                                    -
                                    - -
                                    - error: - string -
                                    - -
                                    -
                                    - -
                                    - error_description: - string -
                                    - -
                                    -
                                    - -
                                    - message: - string -
                                    - -
                                    -
                                    - -
                                    - name: - string -
                                    - -
                                    -
                                    - -
                                    - stack?: - string -
                                    - -
                                    -
                                    - -
                                    - state: - string -
                                    - -
                                    -
                                    - -
                                    - stackTraceLimit: - number -
                                    -
                                    -

                                    - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                    -

                                    - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                    -

                                    - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                    -
                                    - -
                                    -
                                    -
                                    -
                                    - - -

                                    Methods

                                    -                                     -
                                    -
                                    - -
                                      -
                                    • - -
                                      -
                                      -

                                      - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                      - 
                                      const myObject = {};
                                      Error.captureStackTrace(myObject);
                                      myObject.stack;  // Similar to `new Error().stack`
+AuthenticationError | @auth0/auth0-angular
                                      @auth0/auth0-angular
                                        Preparing search index...
                                        Class AuthenticationError
                                        Thrown when handling the redirect callback fails, will be one of Auth0's
+Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses
                                        
+
                                        Hierarchy (View Summary)
                                        Index
                                        Constructors
                                        constructor
+
                                        Properties
                                        appState
+error
+error_description
+message
+name
+stack?
+state
+stackTraceLimit
+
                                        Methods
                                        captureStackTrace
+fromPayload
+prepareStackTrace
+
                                        Constructors
                                        • Parameters
                                          • error: string
                                          • error_description: string
                                          • state: string
                                          • OptionalappState: any
                                          Returns AuthenticationError
                                        Properties
                                        appState: any
                                        error: string
                                        error_description: string
                                        message: string
                                        name: string
                                        stack?: string
                                        state: string
                                        stackTraceLimit: number
                                        The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                        
+
                                        The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                        
+
                                        If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                        
+
                                        Methods
                                        • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                          
+
                                          const myObject = {};
                                          Error.captureStackTrace(myObject);
                                          myObject.stack;  // Similar to `new Error().stack`
 
                                          
 
-                      
                                          
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                          
-                      
                                          
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                          
-                      
                                          
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                          
-                      
                                          function a() {
                                            b();
                                          }

                                          function b() {
                                            c();
                                          }

                                          function c() {
                                            // Create an error without stack trace to avoid calculating the stack trace twice.
                                            const { stackTraceLimit } = Error;
                                            Error.stackTraceLimit = 0;
                                            const error = new Error();
                                            Error.stackTraceLimit = stackTraceLimit;

                                            // Capture the stack trace above function b
                                            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                            throw error;
                                          }

                                          a();
+
                                          The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                          
+
                                          The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                          
+
                                          The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                          
+
                                          function a() {
                                            b();
                                          }

                                          function b() {
                                            c();
                                          }

                                          function c() {
                                            // Create an error without stack trace to avoid calculating the stack trace twice.
                                            const { stackTraceLimit } = Error;
                                            Error.stackTraceLimit = 0;
                                            const error = new Error();
                                            Error.stackTraceLimit = stackTraceLimit;

                                            // Capture the stack trace above function b
                                            Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                            throw error;
                                          }

                                          a();
 
                                          
-                    
                                          
-                    
                                          
-                      
                                          Parameters
                                          
-                      
                                            
-                        
                                          • 
-                          targetObject:
-                            object
-                        
                                            • 
-                        
                                          • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                            • 
-                      
                                          
-                    
                                          
-                    
                                          
-                      Returns void
-                    
                                          
-                    
-                  
                                          
-                
                                          • 
-              
                                        
-            
                                        
-            
                                        
-              
-              
                                          
-                
                                        • 
-                  
-                  
                                          
-                    
                                          
-                      
                                          Parameters
                                          
-                      
                                            
-                        
                                          • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                            • 
-                      
                                          
-                    
                                          
-                    
                                          
-                      Returns
-                      GenericError
-                    
                                          
-                    
-                  
                                          
-                
                                          • 
-              
                                        
-            
                                        
-            
                                        
-              
-              
-            
                                        
-          
                                        
-        
                                        
-      
                                        
-      
                                        
-        
                                        
-          
                                        
-            
                                        
-              
-                
-                
                                        Settings
                                        
-                                                      
-              
                                        
-                
                                        
-                  Member Visibility
-                  
                                          
-                    
                                        • 
-                      
-                    
                                          • 
-                    
                                        • 
-                      
-                    
                                          • 
-                    
                                        • 
-                      
-                    
                                          • 
-                  
                                        
-                
                                        
-                
                                        
-                  
-                
                                        
-              
                                        
-            
                                        
-          
                                        
-          
                                        
-            
-              
-              
                                        On This Page
                                        
-                                                    
-            
                                        
-              
                                        
-                
-                  Constructors
-                
-                
-              
                                        
-              
                                        
-                
-                  Properties
-                
-                
-              
                                        
-              
                                        
-                
-                  Methods
-                
-                
-              
                                        
-            
                                        
-          
                                        
-        
                                        
-        
                                        
-          
-        
                                        
-      
                                        
-    
                                        
-    
                                        
-    
                                        
-  
-
+
+

                                        Parameters

                                        • targetObject: object
                                        • OptionalconstructorOpt: Function

                                        Returns void

                                      • Parameters

                                        • __namedParameters: { error: string; error_description: string }

                                        Returns GenericError

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Constructors
                                      Properties
                                      Methods
                                      diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 66468955..08556492 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,1398 +1,40 @@ - - - - - - ConnectError | @auth0/auth0-angular - - - - - - - - - - - - -
                                      -
                                      - @auth0/auth0-angular - - - - -
                                        -
                                        -
                                        Preparing search index...
                                        -
                                        -                                         - -
                                        -
                                        -
                                        -
                                        -
                                        - -

                                        Class ConnectError

                                        -
                                        -
                                        -
                                        -

                                        - Thrown when handling the redirect callback for the connect flow - fails, will be one of Auth0's Authentication API's Standard Error - Responses: - https://auth0.com/docs/api/authentication?javascript#standard-error-responses -

                                        -
                                        -
                                        -
                                        -

                                        - Hierarchy (View Summary) -

                                        - -
                                        - -
                                        -
                                        -
                                        - - -
                                        Index
                                        -                                         -
                                        -
                                        -

                                        Constructors

                                        -
                                        - - constructor -
                                        -
                                        -
                                        -

                                        Properties

                                        -
                                        - - appState - - connection - - error - - error_description - - message - - name - - stack? - - state - - stackTraceLimit -
                                        -
                                        -
                                        -

                                        Methods

                                        -
                                        - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        - - -

                                        Constructors

                                        -                                         -
                                        -
                                        - -
                                          -
                                        • - -
                                          -
                                          -

                                          Parameters

                                          -
                                            -
                                          • - error: - string -
                                            • -
                                          • - error_description: - string -
                                            • -
                                          • - connection: - string -
                                            • -
                                          • - state: - string -
                                            • -
                                          • - OptionalappState: - any -
                                            • -
                                          -
                                          -

                                          - Returns - ConnectError -

                                          - -
                                          -
                                          • -
                                        -
                                        -
                                        -
                                        -
                                        - - -

                                        Properties

                                        -                                         -
                                        -
                                        - -
                                        - appState: - any -
                                        - -
                                        -
                                        - -
                                        - connection: - string -
                                        - -
                                        -
                                        - -
                                        - error: - string -
                                        - -
                                        -
                                        - -
                                        - error_description: - string -
                                        - -
                                        -
                                        - -
                                        - message: - string -
                                        - -
                                        -
                                        - -
                                        - name: - string -
                                        - -
                                        -
                                        - -
                                        - stack?: - string -
                                        - -
                                        -
                                        - -
                                        - state: - string -
                                        - -
                                        -
                                        - -
                                        - stackTraceLimit: - number -
                                        -
                                        -

                                        - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                        -

                                        - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                        -

                                        - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                        -
                                        - -
                                        -
                                        -
                                        -
                                        - - -

                                        Methods

                                        -                                         -
                                        -
                                        - -
                                          -
                                        • - -
                                          -
                                          -

                                          - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                          - 
                                          const myObject = {};
                                          Error.captureStackTrace(myObject);
                                          myObject.stack;  // Similar to `new Error().stack`
+ConnectError | @auth0/auth0-angular
                                          @auth0/auth0-angular
                                            Preparing search index...
                                            Class ConnectError
                                            Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's
+Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses
                                            
+
                                            Hierarchy (View Summary)
                                            Index
                                            Constructors
                                            constructor
+
                                            Properties
                                            appState
+connection
+error
+error_description
+message
+name
+stack?
+state
+stackTraceLimit
+
                                            Methods
                                            captureStackTrace
+fromPayload
+prepareStackTrace
+
                                            Constructors
                                            • Parameters
                                              • error: string
                                              • error_description: string
                                              • connection: string
                                              • state: string
                                              • OptionalappState: any
                                              Returns ConnectError
                                            Properties
                                            appState: any
                                            connection: string
                                            error: string
                                            error_description: string
                                            message: string
                                            name: string
                                            stack?: string
                                            state: string
                                            stackTraceLimit: number
                                            The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                            
+
                                            The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                            
+
                                            If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                            
+
                                            Methods
                                            • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                              
+
                                              const myObject = {};
                                              Error.captureStackTrace(myObject);
                                              myObject.stack;  // Similar to `new Error().stack`
 
                                              
 
-                      
                                              
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                              
-                      
                                              
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                              
-                      
                                              
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                              
-                      
                                              function a() {
                                                b();
                                              }

                                              function b() {
                                                c();
                                              }

                                              function c() {
                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                const { stackTraceLimit } = Error;
                                                Error.stackTraceLimit = 0;
                                                const error = new Error();
                                                Error.stackTraceLimit = stackTraceLimit;

                                                // Capture the stack trace above function b
                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                throw error;
                                              }

                                              a();
+
                                              The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                              
+
                                              The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                              
+
                                              The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                              
+
                                              function a() {
                                                b();
                                              }

                                              function b() {
                                                c();
                                              }

                                              function c() {
                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                const { stackTraceLimit } = Error;
                                                Error.stackTraceLimit = 0;
                                                const error = new Error();
                                                Error.stackTraceLimit = stackTraceLimit;

                                                // Capture the stack trace above function b
                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                throw error;
                                              }

                                              a();
 
                                              
-                    
                                              
-                    
                                              
-                      
                                              Parameters
                                              
-                      
                                                
-                        
                                              • 
-                          targetObject:
-                            object
-                        
                                                • 
-                        
                                              • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                • 
-                      
                                              
-                    
                                              
-                    
                                              
-                      Returns void
-                    
                                              
-                    
-                  
                                              
-                
                                              • 
-              
                                            
-            
                                            
-            
                                            
-              
-              
                                              
-                
                                            • 
-                  
-                  
                                              
-                    
                                              
-                      
                                              Parameters
                                              
-                      
                                                
-                        
                                              • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                • 
-                      
                                              
-                    
                                              
-                    
                                              
-                      Returns
-                      GenericError
-                    
                                              
-                    
-                  
                                              
-                
                                              • 
-              
                                            
-            
                                            
-            
                                            
-              
-              
-            
                                            
-          
                                            
-        
                                            
-      
                                            
-      
                                            
-        
                                            
-          
                                            
-            
                                            
-              
-                
-                
                                            Settings
                                            
-                                                          
-              
                                            
-                
                                            
-                  Member Visibility
-                  
                                              
-                    
                                            • 
-                      
-                    
                                              • 
-                    
                                            • 
-                      
-                    
                                              • 
-                    
                                            • 
-                      
-                    
                                              • 
-                  
                                            
-                
                                            
-                
                                            
-                  
-                
                                            
-              
                                            
-            
                                            
-          
                                            
-          
                                            
-            
-              
-              
                                            On This Page
                                            
-                                                        
-            
                                            
-              
                                            
-                
-                  Constructors
-                
-                
-              
                                            
-              
                                            
-                
-                  Properties
-                
-                
-              
                                            
-              
                                            
-                
-                  Methods
-                
-                
-              
                                            
-            
                                            
-          
                                            
-        
                                            
-        
                                            
-          
-        
                                            
-      
                                            
-    
                                            
-    
                                            
-    
                                            
-  
-
+
+

                                            Parameters

                                            • targetObject: object
                                            • OptionalconstructorOpt: Function

                                            Returns void

                                          • Parameters

                                            • __namedParameters: { error: string; error_description: string }

                                            Returns GenericError

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Constructors
                                          Properties
                                          Methods
                                          diff --git a/docs/classes/Fetcher.html b/docs/classes/Fetcher.html index 9407a2fb..dd25edeb 100644 --- a/docs/classes/Fetcher.html +++ b/docs/classes/Fetcher.html @@ -1,2122 +1,17 @@ - - - - - - Fetcher | @auth0/auth0-angular - - - - - - - - - - - - -
                                          -
                                          - @auth0/auth0-angular - - - - -
                                            -
                                            -
                                            Preparing search index...
                                            -
                                            -                                             - -
                                            -
                                            -
                                            -
                                            -
                                            - -

                                            Class Fetcher<TOutput>

                                            -
                                            -
                                            -

                                            Type Parameters

                                            - -
                                            - -
                                            -
                                            -
                                            - - -
                                            Index
                                            -                                             -
                                            -
                                            -

                                            Constructors

                                            -
                                            - - constructor -
                                            -
                                            -
                                            -

                                            Properties

                                            -
                                            - - config - - hooks -
                                            -
                                            -
                                            -

                                            Methods

                                            -
                                            - - buildBaseRequest - - buildUrl - - extractUrl - - fetchWithAuth - - getAccessToken - - getHeader - - handleResponse - - hasUseDpopNonceError - - internalFetchWithAuth - - isAbsoluteUrl - - prepareRequest - - setAuthorizationHeader - - setDpopProofHeader -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            - - -

                                            Constructors

                                            -                                             -
                                            -
                                            - - -
                                            -
                                            -
                                            -
                                            - - -

                                            Properties

                                            -                                             -
                                            -
                                            - -
                                            - config: - Omit<FetcherConfig<TOutput>, - "fetch"> - & - Required<
                                                Pick<FetcherConfig<TOutput>, - "fetch">,
                                            > -
                                            - -
                                            -
                                            - -
                                            - hooks: - FetcherHooks -
                                            - -
                                            -
                                            -
                                            -
                                            - - -

                                            Methods

                                            -                                             -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              • - init: - RequestInit - | - undefined -
                                                • -
                                              -
                                              -

                                              - Returns Request -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - baseUrl: - string - | - undefined -
                                                • -
                                              • - url: - string - | - undefined -
                                                • -
                                              -
                                              -

                                              - Returns string -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              -
                                              -

                                              - Returns string -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              • - Optionalinit: - RequestInit -
                                                • -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<TOutput> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<string - | - GetTokenSilentlyVerboseResponse> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - headers: - ResponseHeaders -
                                                • -
                                              • - name: - string -
                                                • -
                                              -
                                              -

                                              - Returns string -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - response: - TOutput -
                                                • -
                                              • - callbacks: - FetchWithAuthCallbacks<TOutput> -
                                                • -
                                              -
                                              -

                                              - Returns Promise<TOutput> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              - -
                                              -

                                              - Returns boolean -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - info: - RequestInfo - | - URL -
                                                • -
                                              • - init: - RequestInit - | - undefined -
                                                • -
                                              • - callbacks: - FetchWithAuthCallbacks<TOutput> -
                                                • -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<TOutput> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - url: - string -
                                                • -
                                              -
                                              -

                                              - Returns boolean -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - request: - Request -
                                                • -
                                              • - OptionalauthParams: - AuthParams -
                                                • -
                                              -
                                              -

                                              - Returns Promise<void> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - request: - Request -
                                                • -
                                              • - accessToken: - string -
                                                • -
                                              • - OptionaltokenType: - string -
                                                • -
                                              -
                                              -

                                              - Returns void -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            - -
                                              -
                                            • - -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - request: - Request -
                                                • -
                                              • - accessToken: - string -
                                                • -
                                              -
                                              -

                                              - Returns Promise<void> -

                                              - -
                                              -
                                              • -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            - - -

                                            Settings

                                            -                                             -
                                            -
                                            - Member Visibility -
                                              -
                                            • - -
                                              • -
                                            • - -
                                              • -
                                            • - -
                                              • -
                                            -
                                            -
                                            - -
                                            -
                                            -
                                            -
                                            -
                                            - - -

                                            On This Page

                                            -                                             -
                                            -
                                            - - Constructors - - -
                                            -
                                            - - Properties - - -
                                            -
                                            - - Methods - - -
                                            -
                                            -
                                            -
                                            -
                                            - -
                                            -
                                            -
                                            -
                                            -
                                            - - +Fetcher | @auth0/auth0-angular
                                            @auth0/auth0-angular
                                              Preparing search index...

                                              Class Fetcher<TOutput>

                                              Type Parameters

                                              Index

                                              Constructors

                                              constructor +

                                              Properties

                                              config +hooks +

                                              Methods

                                              buildBaseRequest +buildUrl +extractUrl +fetchWithAuth +getAccessToken +getHeader +handleResponse +hasUseDpopNonceError +internalFetchWithAuth +isAbsoluteUrl +prepareRequest +setAuthorizationHeader +setDpopProofHeader +

                                              Constructors

                                              Properties

                                              config: Omit<FetcherConfig<TOutput>, "fetch"> & Required<
                                                  Pick<FetcherConfig<TOutput>, "fetch">,
                                              >
                                              hooks: FetcherHooks

                                              Methods

                                              • Parameters

                                                • info: RequestInfo | URL
                                                • init: RequestInit | undefined

                                                Returns Request

                                              • Parameters

                                                • baseUrl: string | undefined
                                                • url: string | undefined

                                                Returns string

                                              • Parameters

                                                • info: RequestInfo | URL

                                                Returns string

                                              • Parameters

                                                • info: RequestInfo | URL
                                                • Optionalinit: RequestInit
                                                • OptionalauthParams: AuthParams

                                                Returns Promise<TOutput>

                                              • Parameters

                                                • OptionalauthParams: AuthParams

                                                Returns Promise<string | GetTokenSilentlyVerboseResponse>

                                              • Parameters

                                                • headers: ResponseHeaders
                                                • name: string

                                                Returns string

                                              • Parameters

                                                Returns Promise<TOutput>

                                              • Parameters

                                                Returns boolean

                                              • Parameters

                                                • info: RequestInfo | URL
                                                • init: RequestInit | undefined
                                                • callbacks: FetchWithAuthCallbacks<TOutput>
                                                • OptionalauthParams: AuthParams

                                                Returns Promise<TOutput>

                                              • Parameters

                                                • url: string

                                                Returns boolean

                                              • Parameters

                                                • request: Request
                                                • OptionalauthParams: AuthParams

                                                Returns Promise<void>

                                              • Parameters

                                                • request: Request
                                                • accessToken: string
                                                • OptionaltokenType: string

                                                Returns void

                                              • Parameters

                                                • request: Request
                                                • accessToken: string

                                                Returns Promise<void>

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Constructors
                                              Properties
                                              Methods
                                              diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index e6d8b5d5..767adb52 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,1217 +1,36 @@ - - - - - - GenericError | @auth0/auth0-angular - - - - - - - - - - - - -
                                              -
                                              - @auth0/auth0-angular - - - - -
                                                -
                                                -
                                                Preparing search index...
                                                -
                                                -                                                 - -
                                                -
                                                -
                                                -
                                                -
                                                - -

                                                Class GenericError

                                                -
                                                -
                                                -
                                                -

                                                Thrown when network requests to the Auth server fail.

                                                -
                                                -
                                                -
                                                -

                                                - Hierarchy (View Summary) -

                                                - -
                                                - -
                                                -
                                                -
                                                - - -
                                                Index
                                                -                                                 -
                                                -
                                                -

                                                Constructors

                                                -
                                                - - constructor -
                                                -
                                                -
                                                -

                                                Properties

                                                -
                                                - - error - - error_description - - message - - name - - stack? - - stackTraceLimit -
                                                -
                                                -
                                                -

                                                Methods

                                                -
                                                - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                - - -

                                                Constructors

                                                -                                                 -
                                                -
                                                - -
                                                  -
                                                • - -
                                                  -
                                                  -

                                                  Parameters

                                                  -
                                                    -
                                                  • - error: - string -
                                                    • -
                                                  • - error_description: - string -
                                                    • -
                                                  -
                                                  -

                                                  - Returns - GenericError -

                                                  - -
                                                  -
                                                  • -
                                                -
                                                -
                                                -
                                                -
                                                - - -

                                                Properties

                                                -                                                 -
                                                -
                                                - -
                                                - error: - string -
                                                - -
                                                -
                                                - -
                                                - error_description: - string -
                                                - -
                                                -
                                                - -
                                                - message: - string -
                                                - -
                                                -
                                                - -
                                                - name: - string -
                                                - -
                                                -
                                                - -
                                                - stack?: - string -
                                                - -
                                                -
                                                - -
                                                - stackTraceLimit: - number -
                                                -
                                                -

                                                - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                -

                                                - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                -

                                                - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                -
                                                - -
                                                -
                                                -
                                                -
                                                - - -

                                                Methods

                                                -                                                 -
                                                -
                                                - -
                                                  -
                                                • - -
                                                  -
                                                  -

                                                  - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                  - 
                                                  const myObject = {};
                                                  Error.captureStackTrace(myObject);
                                                  myObject.stack;  // Similar to `new Error().stack`
+GenericError | @auth0/auth0-angular
                                                  @auth0/auth0-angular
                                                    Preparing search index...
                                                    Class GenericError
                                                    Thrown when network requests to the Auth server fail.
                                                    
+
                                                    Hierarchy (View Summary)
                                                    Index
                                                    Constructors
                                                    constructor
+
                                                    Properties
                                                    error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                    Methods
                                                    captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                    Constructors
                                                    • Parameters
                                                      • error: string
                                                      • error_description: string
                                                      Returns GenericError
                                                    Properties
                                                    error: string
                                                    error_description: string
                                                    message: string
                                                    name: string
                                                    stack?: string
                                                    stackTraceLimit: number
                                                    The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                    
+
                                                    The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                    
+
                                                    If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                    
+
                                                    Methods
                                                    • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                      
+
                                                      const myObject = {};
                                                      Error.captureStackTrace(myObject);
                                                      myObject.stack;  // Similar to `new Error().stack`
 
                                                      
 
-                      
                                                      
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                      
-                      
                                                      
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                      
-                      
                                                      
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                      
-                      
                                                      function a() {
                                                        b();
                                                      }

                                                      function b() {
                                                        c();
                                                      }

                                                      function c() {
                                                        // Create an error without stack trace to avoid calculating the stack trace twice.
                                                        const { stackTraceLimit } = Error;
                                                        Error.stackTraceLimit = 0;
                                                        const error = new Error();
                                                        Error.stackTraceLimit = stackTraceLimit;

                                                        // Capture the stack trace above function b
                                                        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                        throw error;
                                                      }

                                                      a();
+
                                                      The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                      
+
                                                      The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                      
+
                                                      The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                      
+
                                                      function a() {
                                                        b();
                                                      }

                                                      function b() {
                                                        c();
                                                      }

                                                      function c() {
                                                        // Create an error without stack trace to avoid calculating the stack trace twice.
                                                        const { stackTraceLimit } = Error;
                                                        Error.stackTraceLimit = 0;
                                                        const error = new Error();
                                                        Error.stackTraceLimit = stackTraceLimit;

                                                        // Capture the stack trace above function b
                                                        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                        throw error;
                                                      }

                                                      a();
 
                                                      
-                    
                                                      
-                    
                                                      
-                      
                                                      Parameters
                                                      
-                      
                                                        
-                        
                                                      • 
-                          targetObject:
-                            object
-                        
                                                        • 
-                        
                                                      • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                        • 
-                      
                                                      
-                    
                                                      
-                    
                                                      
-                      Returns void
-                    
                                                      
-                    
-                  
                                                      
-                
                                                      • 
-              
                                                    
-            
                                                    
-            
                                                    
-              
-              
                                                      
-                
                                                    • 
-                  
-                  
                                                      
-                    
                                                      
-                      
                                                      Parameters
                                                      
-                      
                                                        
-                        
                                                      • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                        • 
-                      
                                                      
-                    
                                                      
-                    
                                                      
-                      Returns
-                      GenericError
-                    
                                                      
-                    
-                  
                                                      
-                
                                                      • 
-              
                                                    
-            
                                                    
-            
                                                    
-              
-              
                                                      
-                
                                                    • 
-                  
-                  
                                                      
-                    
                                                      
-                      
                                                      Parameters
                                                      
-                      
                                                        
-                        
                                                      • 
-                          err:
-                            Error
-                        
                                                        • 
-                        
                                                      • 
-                          stackTraces: CallSite[]
-                        
                                                        • 
-                      
                                                      
-                    
                                                      
-                    
                                                      
-                      Returns any
-                    
                                                      
-                    
                                                      
-                      
                                                      
-                        
-                        
                                                      
-                          https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-                        
                                                      
-                      
                                                      
-                    
                                                      
-                    
-                  
                                                      
-                
                                                      • 
-              
                                                    
-            
                                                    
-          
                                                    
-        
                                                    
-      
                                                    
-      
                                                    
-        
                                                    
-          
                                                    
-            
                                                    
-              
-                
-                
                                                    Settings
                                                    
-                                                                  
-              
                                                    
-                
                                                    
-                  Member Visibility
-                  
                                                      
-                    
                                                    • 
-                      
-                    
                                                      • 
-                    
                                                    • 
-                      
-                    
                                                      • 
-                    
                                                    • 
-                      
-                    
                                                      • 
-                  
                                                    
-                
                                                    
-                
                                                    
-                  
-                
                                                    
-              
                                                    
-            
                                                    
-          
                                                    
-          
                                                    
-            
-              
-              
                                                    On This Page
                                                    
-                                                                
-            
                                                    
-              
                                                    
-                
-                  Constructors
-                
-                
-              
                                                    
-              
                                                    
-                
-                  Properties
-                
-                
-              
                                                    
-              
                                                    
-                
-                  Methods
-                
-                
-              
                                                    
-            
                                                    
-          
                                                    
-        
                                                    
-        
                                                    
-          
-        
                                                    
-      
                                                    
-    
                                                    
-    
                                                    
-    
                                                    
-  
-
+
+

                                                    Parameters

                                                    • targetObject: object
                                                    • OptionalconstructorOpt: Function

                                                    Returns void

                                                  • Parameters

                                                    • __namedParameters: { error: string; error_description: string }

                                                    Returns GenericError

                                                  Settings

                                                  Member Visibility

                                                  On This Page

                                                  Constructors
                                                  Properties
                                                  Methods
                                                  diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index c6a81cb5..76a223a7 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1,474 +1,3 @@ - - - - - - InMemoryCache | @auth0/auth0-angular - - - - - - - - - - - - -
                                                  -
                                                  - @auth0/auth0-angular - - - - -
                                                    -
                                                    -
                                                    Preparing search index...
                                                    -
                                                    -                                                     - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - -

                                                    Class InMemoryCache

                                                    -
                                                    - -
                                                    -
                                                    -
                                                    - - -
                                                    Index
                                                    -                                                     -
                                                    -
                                                    -

                                                    Constructors

                                                    -
                                                    - - constructor -
                                                    -
                                                    -
                                                    -

                                                    Properties

                                                    -
                                                    - - enclosedCache -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -

                                                    Constructors

                                                    -                                                     -
                                                    -
                                                    - - -
                                                    -
                                                    -
                                                    -
                                                    - - -

                                                    Properties

                                                    -                                                     -
                                                    -
                                                    - -
                                                    - enclosedCache: - ICache -
                                                    - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -

                                                    Settings

                                                    -                                                     -
                                                    -
                                                    - Member Visibility -
                                                      -
                                                    • - -
                                                      • -
                                                    • - -
                                                      • -
                                                    • - -
                                                      • -
                                                    -
                                                    -
                                                    - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -

                                                    On This Page

                                                    -                                                     -
                                                    -
                                                    - - Constructors - - -
                                                    -
                                                    - - Properties - - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - +InMemoryCache | @auth0/auth0-angular
                                                    @auth0/auth0-angular
                                                      Preparing search index...

                                                      Class InMemoryCache

                                                      Index

                                                      Constructors

                                                      constructor +

                                                      Properties

                                                      enclosedCache +

                                                      Constructors

                                                      Properties

                                                      enclosedCache: ICache

                                                      Settings

                                                      Member Visibility

                                                      On This Page

                                                      Constructors
                                                      Properties
                                                      diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index c80744c9..2b23f79f 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1,833 +1,6 @@ - - - - - - LocalStorageCache | @auth0/auth0-angular - - - - - - - - - - - - -
                                                      -
                                                      - @auth0/auth0-angular - - - - -
                                                        -
                                                        -
                                                        Preparing search index...
                                                        -
                                                        -                                                         - -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - -

                                                        Class LocalStorageCache

                                                        -
                                                        -
                                                        -

                                                        Implements

                                                        - -
                                                        - -
                                                        -
                                                        -
                                                        - - -
                                                        Index
                                                        -                                                         -
                                                        -
                                                        -

                                                        Constructors

                                                        -
                                                        - - constructor -
                                                        -
                                                        -
                                                        -

                                                        Methods

                                                        -
                                                        - - allKeys - - get - - remove - - set -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - - -

                                                        Constructors

                                                        -                                                         -
                                                        -
                                                        - - -
                                                        -
                                                        -
                                                        -
                                                        - - -

                                                        Methods

                                                        -                                                         -
                                                        -
                                                        - -
                                                          -
                                                        • - -
                                                          -

                                                          - Returns string[] -

                                                          - -
                                                          -
                                                          • -
                                                        -
                                                        -
                                                        - -
                                                          -
                                                        • - -
                                                          -
                                                          -

                                                          Type Parameters

                                                          - -
                                                          -
                                                          -

                                                          Parameters

                                                          -
                                                            -
                                                          • - key: - string -
                                                            • -
                                                          -
                                                          -

                                                          - Returns - MaybePromise<T - | - undefined> -

                                                          - -
                                                          -
                                                          • -
                                                        -
                                                        -
                                                        - -
                                                          -
                                                        • - -
                                                          -
                                                          -

                                                          Parameters

                                                          -
                                                            -
                                                          • - key: - string -
                                                            • -
                                                          -
                                                          -

                                                          - Returns void -

                                                          - -
                                                          -
                                                          • -
                                                        -
                                                        -
                                                        - -
                                                          -
                                                        • - -
                                                          -
                                                          -

                                                          Type Parameters

                                                          - -
                                                          -
                                                          -

                                                          Parameters

                                                          -
                                                            -
                                                          • - key: - string -
                                                            • -
                                                          • - entry: - T -
                                                            • -
                                                          -
                                                          -

                                                          - Returns void -

                                                          - -
                                                          -
                                                          • -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - - -

                                                        Settings

                                                        -                                                         -
                                                        -
                                                        - Member Visibility -
                                                          -
                                                        • - -
                                                          • -
                                                        • - -
                                                          • -
                                                        • - -
                                                          • -
                                                        -
                                                        -
                                                        - -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - - -

                                                        On This Page

                                                        -                                                         -
                                                        -
                                                        - - Constructors - - -
                                                        -
                                                        - - Methods - - -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - - +LocalStorageCache | @auth0/auth0-angular
                                                        @auth0/auth0-angular
                                                          Preparing search index...

                                                          Class LocalStorageCache

                                                          Implements

                                                          Index

                                                          Constructors

                                                          constructor +

                                                          Methods

                                                          allKeys +get +remove +set +

                                                          Constructors

                                                          Methods

                                                          • Returns string[]

                                                          • Type Parameters

                                                            Parameters

                                                            • key: string

                                                            Returns MaybePromise<T | undefined>

                                                          • Parameters

                                                            • key: string

                                                            Returns void

                                                          • Type Parameters

                                                            Parameters

                                                            • key: string
                                                            • entry: T

                                                            Returns void

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          Constructors
                                                          Methods
                                                          diff --git a/docs/classes/MfaChallengeError.html b/docs/classes/MfaChallengeError.html index 0c25808e..af44c068 100644 --- a/docs/classes/MfaChallengeError.html +++ b/docs/classes/MfaChallengeError.html @@ -1,1243 +1,39 @@ - - - - - - MfaChallengeError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                          -
                                                          - @auth0/auth0-angular - - - - -
                                                            -
                                                            -
                                                            Preparing search index...
                                                            -
                                                            -                                                             - -
                                                            -
                                                            -
                                                            -
                                                            -
                                                            - -

                                                            Class MfaChallengeError

                                                            -
                                                            -
                                                            -
                                                            -

                                                            Error thrown when initiating an MFA challenge fails.

                                                            -
                                                            -
                                                            -
                                                            - - 
                                                            try {
                                                              const challenge = await mfa.challenge({
                                                                mfaToken: mfaToken,
                                                                challengeType: 'otp',
                                                                authenticatorId: 'otp|dev_123'
                                                              });
                                                            } catch (error) {
                                                              if (error instanceof MfaChallengeError) {
                                                                console.log(error.error); // 'too_many_attempts'
                                                                console.log(error.error_description); // 'Rate limit exceeded'
                                                              }
                                                            }
+MfaChallengeError | @auth0/auth0-angular
                                                            @auth0/auth0-angular
                                                              Preparing search index...
                                                              Class MfaChallengeError
                                                              Error thrown when initiating an MFA challenge fails.
                                                              
+
                                                              try {
                                                                const challenge = await mfa.challenge({
                                                                  mfaToken: mfaToken,
                                                                  challengeType: 'otp',
                                                                  authenticatorId: 'otp|dev_123'
                                                                });
                                                              } catch (error) {
                                                                if (error instanceof MfaChallengeError) {
                                                                  console.log(error.error); // 'too_many_attempts'
                                                                  console.log(error.error_description); // 'Rate limit exceeded'
                                                                }
                                                              }
 
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
                                                              
-            Hierarchy (View Summary)
-          
                                                              
-          
                                                                
-            
                                                              • 
-              MfaError
-              
                                                                  
-                
                                                                • 
-                  MfaChallengeError
-                
                                                                  • 
-              
                                                                
-            
                                                                • 
-          
                                                              
-        
                                                              
-        
-        
                                                              
-          
                                                              
-            
                                                              
-              
-                
-                
                                                              Index
                                                              
-                                                                            
-              
                                                              
-                
                                                              
-                  
                                                              Constructors
                                                              
-                  
                                                              
-                    
-                        constructor
-                  
                                                              
-                
                                                              
-                
                                                              
-                  
                                                              Properties
                                                              
-                  
                                                              
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        stack?
-                    
-                        stackTraceLimit
-                  
                                                              
-                
                                                              
-                
                                                              
-                  
                                                              Methods
                                                              
-                  
                                                              
-                    
-                        captureStackTrace
-                    
-                        fromPayload
-                    
-                        prepareStackTrace
-                  
                                                              
-                
                                                              
-              
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-            
-            
                                                              Constructors
                                                              
-                                                                        
-          
                                                              
-            
                                                              
-              
-              
                                                                
-                
                                                              • 
-                  
-                  
                                                                
-                    
                                                                
-                      
                                                                Parameters
                                                                
-                      
                                                                  
-                        
                                                                • 
-                          error:
-                            string
-                        
                                                                  • 
-                        
                                                                • 
-                          error_description:
-                            string
-                        
                                                                  • 
-                      
                                                                
-                    
                                                                
-                    
                                                                
-                      Returns
-                      MfaChallengeError
-                    
                                                                
-                    
-                  
                                                                
-                
                                                                • 
-              
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-            
-            
                                                              Properties
                                                              
-                                                                        
-          
                                                              
-            
                                                              
-              
-              
                                                              
-                error:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                error_description:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                message:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                name:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                stack?:
-                string
-              
                                                              
-              
-            
                                                              
-            
                                                              
-              
-              
                                                              
-                stackTraceLimit:
-                number
-              
                                                              
-              
                                                              
-                
                                                              
-                  The Error.stackTraceLimit property specifies the
-                  number of stack frames collected by a stack trace (whether
-                  generated by new Error().stack or
-                  Error.captureStackTrace(obj)).
-                
                                                              
-                
                                                              
-                  The default value is 10 but may be set to any
-                  valid JavaScript number. Changes will affect any stack trace
-                  captured after the value has been changed.
-                
                                                              
-                
                                                              
-                  If set to a non-number value, or set to a negative number,
-                  stack traces will not capture any frames.
-                
                                                              
-              
                                                              
-              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-            
-            
                                                              Methods
                                                              
-                                                                        
-          
                                                              
-            
                                                              
-              
-              
                                                                
-                
                                                              • 
-                  
-                  
                                                                
-                    
                                                                
-                      
                                                                
-                        Creates a .stack property on
-                        targetObject, which when accessed returns a
-                        string representing the location in the code at which
-                        Error.captureStackTrace() was called.
-                      
                                                                
-                      
                                                                const myObject = {};
                                                                Error.captureStackTrace(myObject);
                                                                myObject.stack;  // Similar to `new Error().stack`
+
+
                                                              Hierarchy (View Summary)
                                                              Index
                                                              Constructors
                                                              constructor
+
                                                              Properties
                                                              error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                              Methods
                                                              captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                              Constructors
                                                              • Parameters
                                                                • error: string
                                                                • error_description: string
                                                                Returns MfaChallengeError
                                                              Properties
                                                              error: string
                                                              error_description: string
                                                              message: string
                                                              name: string
                                                              stack?: string
                                                              stackTraceLimit: number
                                                              The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                              
+
                                                              The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                              
+
                                                              If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                              
+
                                                              Methods
                                                              • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                
+
                                                                const myObject = {};
                                                                Error.captureStackTrace(myObject);
                                                                myObject.stack;  // Similar to `new Error().stack`
 
                                                                
 
-                      
                                                                
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                
-                      
                                                                
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                
-                      
                                                                
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                
-                      
                                                                function a() {
                                                                  b();
                                                                }

                                                                function b() {
                                                                  c();
                                                                }

                                                                function c() {
                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                  const { stackTraceLimit } = Error;
                                                                  Error.stackTraceLimit = 0;
                                                                  const error = new Error();
                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                  // Capture the stack trace above function b
                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                  throw error;
                                                                }

                                                                a();
+
                                                                The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                
+
                                                                The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                
+
                                                                The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                
+
                                                                function a() {
                                                                  b();
                                                                }

                                                                function b() {
                                                                  c();
                                                                }

                                                                function c() {
                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                  const { stackTraceLimit } = Error;
                                                                  Error.stackTraceLimit = 0;
                                                                  const error = new Error();
                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                  // Capture the stack trace above function b
                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                  throw error;
                                                                }

                                                                a();
 
                                                                
-                    
                                                                
-                    
                                                                
-                      
                                                                Parameters
                                                                
-                      
                                                                  
-                        
                                                                • 
-                          targetObject:
-                            object
-                        
                                                                  • 
-                        
                                                                • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                  • 
-                      
                                                                
-                    
                                                                
-                    
                                                                
-                      Returns void
-                    
                                                                
-                    
-                  
                                                                
-                
                                                                • 
-              
                                                              
-            
                                                              
-            
                                                              
-              
-              
                                                                
-                
                                                              • 
-                  
-                  
                                                                
-                    
                                                                
-                      
                                                                Parameters
                                                                
-                      
                                                                  
-                        
                                                                • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                  • 
-                      
                                                                
-                    
                                                                
-                    
                                                                
-                      Returns
-                      MfaError
-                    
                                                                
-                    
-                  
                                                                
-                
                                                                • 
-              
                                                              
-            
                                                              
-            
                                                              
-              
-              
-            
                                                              
-          
                                                              
-        
                                                              
-      
                                                              
-      
                                                              
-        
                                                              
-          
                                                              
-            
                                                              
-              
-                
-                
                                                              Settings
                                                              
-                                                                            
-              
                                                              
-                
                                                              
-                  Member Visibility
-                  
                                                                
-                    
                                                              • 
-                      
-                    
                                                                • 
-                    
                                                              • 
-                      
-                    
                                                                • 
-                    
                                                              • 
-                      
-                    
                                                                • 
-                  
                                                              
-                
                                                              
-                
                                                              
-                  
-                
                                                              
-              
                                                              
-            
                                                              
-          
                                                              
-          
                                                              
-            
-              
-              
                                                              On This Page
                                                              
-                                                                          
-            
                                                              
-              
                                                              
-                
-                  Constructors
-                
-                
-              
                                                              
-              
                                                              
-                
-                  Properties
-                
-                
-              
                                                              
-              
                                                              
-                
-                  Methods
-                
-                
-              
                                                              
-            
                                                              
-          
                                                              
-        
                                                              
-        
                                                              
-          
-        
                                                              
-      
                                                              
-    
                                                              
-    
                                                              
-    
                                                              
-  
-
+
+

                                                              Parameters

                                                              • targetObject: object
                                                              • OptionalconstructorOpt: Function

                                                              Returns void

                                                              • Parameters

                                                                • __namedParameters: { error: string; error_description: string }

                                                                Returns MfaError

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Constructors
                                                              Properties
                                                              Methods
                                                              diff --git a/docs/classes/MfaEnrollmentError.html b/docs/classes/MfaEnrollmentError.html index 825a3957..7761c029 100644 --- a/docs/classes/MfaEnrollmentError.html +++ b/docs/classes/MfaEnrollmentError.html @@ -1,1243 +1,39 @@ - - - - - - MfaEnrollmentError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                              -
                                                              - @auth0/auth0-angular - - - - -
                                                                -
                                                                -
                                                                Preparing search index...
                                                                -
                                                                -                                                                 - -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                - -

                                                                Class MfaEnrollmentError

                                                                -
                                                                -
                                                                -
                                                                -

                                                                Error thrown when enrolling an MFA authenticator fails.

                                                                -
                                                                -
                                                                -
                                                                - - 
                                                                try {
                                                                  const enrollment = await mfa.enroll({
                                                                    authenticator_types: ['otp']
                                                                  });
                                                                } catch (error) {
                                                                  if (error instanceof MfaEnrollmentError) {
                                                                    console.log(error.error); // 'invalid_phone_number'
                                                                    console.log(error.error_description); // 'Invalid phone number format'
                                                                  }
                                                                }
+MfaEnrollmentError | @auth0/auth0-angular
                                                                @auth0/auth0-angular
                                                                  Preparing search index...
                                                                  Class MfaEnrollmentError
                                                                  Error thrown when enrolling an MFA authenticator fails.
                                                                  
+
                                                                  try {
                                                                    const enrollment = await mfa.enroll({
                                                                      authenticator_types: ['otp']
                                                                    });
                                                                  } catch (error) {
                                                                    if (error instanceof MfaEnrollmentError) {
                                                                      console.log(error.error); // 'invalid_phone_number'
                                                                      console.log(error.error_description); // 'Invalid phone number format'
                                                                    }
                                                                  }
 
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
                                                                  
-            Hierarchy (View Summary)
-          
                                                                  
-          
                                                                    
-            
                                                                  • 
-              MfaError
-              
                                                                      
-                
                                                                    • 
-                  MfaEnrollmentError
-                
                                                                      • 
-              
                                                                    
-            
                                                                    • 
-          
                                                                  
-        
                                                                  
-        
-        
                                                                  
-          
                                                                  
-            
                                                                  
-              
-                
-                
                                                                  Index
                                                                  
-                                                                                
-              
                                                                  
-                
                                                                  
-                  
                                                                  Constructors
                                                                  
-                  
                                                                  
-                    
-                        constructor
-                  
                                                                  
-                
                                                                  
-                
                                                                  
-                  
                                                                  Properties
                                                                  
-                  
                                                                  
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        stack?
-                    
-                        stackTraceLimit
-                  
                                                                  
-                
                                                                  
-                
                                                                  
-                  
                                                                  Methods
                                                                  
-                  
                                                                  
-                    
-                        captureStackTrace
-                    
-                        fromPayload
-                    
-                        prepareStackTrace
-                  
                                                                  
-                
                                                                  
-              
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-            
-            
                                                                  Constructors
                                                                  
-                                                                            
-          
                                                                  
-            
                                                                  
-              
-              
                                                                    
-                
                                                                  • 
-                  
-                  
                                                                    
-                    
                                                                    
-                      
                                                                    Parameters
                                                                    
-                      
                                                                      
-                        
                                                                    • 
-                          error:
-                            string
-                        
                                                                      • 
-                        
                                                                    • 
-                          error_description:
-                            string
-                        
                                                                      • 
-                      
                                                                    
-                    
                                                                    
-                    
                                                                    
-                      Returns
-                      MfaEnrollmentError
-                    
                                                                    
-                    
-                  
                                                                    
-                
                                                                    • 
-              
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-            
-            
                                                                  Properties
                                                                  
-                                                                            
-          
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                error:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                error_description:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                message:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                name:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                stack?:
-                string
-              
                                                                  
-              
-            
                                                                  
-            
                                                                  
-              
-              
                                                                  
-                stackTraceLimit:
-                number
-              
                                                                  
-              
                                                                  
-                
                                                                  
-                  The Error.stackTraceLimit property specifies the
-                  number of stack frames collected by a stack trace (whether
-                  generated by new Error().stack or
-                  Error.captureStackTrace(obj)).
-                
                                                                  
-                
                                                                  
-                  The default value is 10 but may be set to any
-                  valid JavaScript number. Changes will affect any stack trace
-                  captured after the value has been changed.
-                
                                                                  
-                
                                                                  
-                  If set to a non-number value, or set to a negative number,
-                  stack traces will not capture any frames.
-                
                                                                  
-              
                                                                  
-              
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-            
-            
                                                                  Methods
                                                                  
-                                                                            
-          
                                                                  
-            
                                                                  
-              
-              
                                                                    
-                
                                                                  • 
-                  
-                  
                                                                    
-                    
                                                                    
-                      
                                                                    
-                        Creates a .stack property on
-                        targetObject, which when accessed returns a
-                        string representing the location in the code at which
-                        Error.captureStackTrace() was called.
-                      
                                                                    
-                      
                                                                    const myObject = {};
                                                                    Error.captureStackTrace(myObject);
                                                                    myObject.stack;  // Similar to `new Error().stack`
+
+
                                                                  Hierarchy (View Summary)
                                                                  Index
                                                                  Constructors
                                                                  constructor
+
                                                                  Properties
                                                                  error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                                  Methods
                                                                  captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                  Constructors
                                                                  • Parameters
                                                                    • error: string
                                                                    • error_description: string
                                                                    Returns MfaEnrollmentError
                                                                  Properties
                                                                  error: string
                                                                  error_description: string
                                                                  message: string
                                                                  name: string
                                                                  stack?: string
                                                                  stackTraceLimit: number
                                                                  The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                  
+
                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                  
+
                                                                  If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                  
+
                                                                  Methods
                                                                  • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                    
+
                                                                    const myObject = {};
                                                                    Error.captureStackTrace(myObject);
                                                                    myObject.stack;  // Similar to `new Error().stack`
 
                                                                    
 
-                      
                                                                    
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                    
-                      
                                                                    
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                    
-                      
                                                                    
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                    
-                      
                                                                    function a() {
                                                                      b();
                                                                    }

                                                                    function b() {
                                                                      c();
                                                                    }

                                                                    function c() {
                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                      const { stackTraceLimit } = Error;
                                                                      Error.stackTraceLimit = 0;
                                                                      const error = new Error();
                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                      // Capture the stack trace above function b
                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                      throw error;
                                                                    }

                                                                    a();
+
                                                                    The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                    
+
                                                                    The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                    
+
                                                                    The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                    
+
                                                                    function a() {
                                                                      b();
                                                                    }

                                                                    function b() {
                                                                      c();
                                                                    }

                                                                    function c() {
                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                      const { stackTraceLimit } = Error;
                                                                      Error.stackTraceLimit = 0;
                                                                      const error = new Error();
                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                      // Capture the stack trace above function b
                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                      throw error;
                                                                    }

                                                                    a();
 
                                                                    
-                    
                                                                    
-                    
                                                                    
-                      
                                                                    Parameters
                                                                    
-                      
                                                                      
-                        
                                                                    • 
-                          targetObject:
-                            object
-                        
                                                                      • 
-                        
                                                                    • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                      • 
-                      
                                                                    
-                    
                                                                    
-                    
                                                                    
-                      Returns void
-                    
                                                                    
-                    
-                  
                                                                    
-                
                                                                    • 
-              
                                                                  
-            
                                                                  
-            
                                                                  
-              
-              
                                                                    
-                
                                                                  • 
-                  
-                  
                                                                    
-                    
                                                                    
-                      
                                                                    Parameters
                                                                    
-                      
                                                                      
-                        
                                                                    • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                      • 
-                      
                                                                    
-                    
                                                                    
-                    
                                                                    
-                      Returns
-                      MfaError
-                    
                                                                    
-                    
-                  
                                                                    
-                
                                                                    • 
-              
                                                                  
-            
                                                                  
-            
                                                                  
-              
-              
-            
                                                                  
-          
                                                                  
-        
                                                                  
-      
                                                                  
-      
                                                                  
-        
                                                                  
-          
                                                                  
-            
                                                                  
-              
-                
-                
                                                                  Settings
                                                                  
-                                                                                
-              
                                                                  
-                
                                                                  
-                  Member Visibility
-                  
                                                                    
-                    
                                                                  • 
-                      
-                    
                                                                    • 
-                    
                                                                  • 
-                      
-                    
                                                                    • 
-                    
                                                                  • 
-                      
-                    
                                                                    • 
-                  
                                                                  
-                
                                                                  
-                
                                                                  
-                  
-                
                                                                  
-              
                                                                  
-            
                                                                  
-          
                                                                  
-          
                                                                  
-            
-              
-              
                                                                  On This Page
                                                                  
-                                                                              
-            
                                                                  
-              
                                                                  
-                
-                  Constructors
-                
-                
-              
                                                                  
-              
                                                                  
-                
-                  Properties
-                
-                
-              
                                                                  
-              
                                                                  
-                
-                  Methods
-                
-                
-              
                                                                  
-            
                                                                  
-          
                                                                  
-        
                                                                  
-        
                                                                  
-          
-        
                                                                  
-      
                                                                  
-    
                                                                  
-    
                                                                  
-    
                                                                  
-  
-
+
+

                                                                  Parameters

                                                                  • targetObject: object
                                                                  • OptionalconstructorOpt: Function

                                                                  Returns void

                                                                  • Parameters

                                                                    • __namedParameters: { error: string; error_description: string }

                                                                    Returns MfaError

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Constructors
                                                                  Properties
                                                                  Methods
                                                                  diff --git a/docs/classes/MfaEnrollmentFactorsError.html b/docs/classes/MfaEnrollmentFactorsError.html index 111b87b1..b51e6ed0 100644 --- a/docs/classes/MfaEnrollmentFactorsError.html +++ b/docs/classes/MfaEnrollmentFactorsError.html @@ -1,1247 +1,39 @@ - - - - - - MfaEnrollmentFactorsError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                  -
                                                                  - @auth0/auth0-angular - - - - -
                                                                    -
                                                                    -
                                                                    Preparing search index...
                                                                    -
                                                                    -                                                                     - -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - -

                                                                    Class MfaEnrollmentFactorsError

                                                                    -
                                                                    -
                                                                    -
                                                                    -

                                                                    Error thrown when getting enrollment factors fails.

                                                                    -
                                                                    -
                                                                    -
                                                                    - - 
                                                                    try {
                                                                      const factors = await mfa.getEnrollmentFactors(mfaToken);
                                                                    } catch (error) {
                                                                      if (error instanceof MfaEnrollmentFactorsError) {
                                                                        console.log(error.error); // 'mfa_context_not_found'
                                                                        console.log(error.error_description); // 'MFA context not found...'
                                                                      }
                                                                    }
+MfaEnrollmentFactorsError | @auth0/auth0-angular
                                                                    @auth0/auth0-angular
                                                                      Preparing search index...
                                                                      Class MfaEnrollmentFactorsError
                                                                      Error thrown when getting enrollment factors fails.
                                                                      
+
                                                                      try {
                                                                        const factors = await mfa.getEnrollmentFactors(mfaToken);
                                                                      } catch (error) {
                                                                        if (error instanceof MfaEnrollmentFactorsError) {
                                                                          console.log(error.error); // 'mfa_context_not_found'
                                                                          console.log(error.error_description); // 'MFA context not found...'
                                                                        }
                                                                      }
 
                                                                      
-            
                                                                      
-          
                                                                      
-        
                                                                      
-        
                                                                      
-          
                                                                      
-            Hierarchy (View Summary)
-          
                                                                      
-          
                                                                        
-            
                                                                      • 
-              MfaError
-              
                                                                          
-                
                                                                        • 
-                  MfaEnrollmentFactorsError
-                
                                                                          • 
-              
                                                                        
-            
                                                                        • 
-          
                                                                      
-        
                                                                      
-        
-        
                                                                      
-          
                                                                      
-            
                                                                      
-              
-                
-                
                                                                      Index
                                                                      
-                                                                                    
-              
                                                                      
-                
                                                                      
-                  
                                                                      Constructors
                                                                      
-                  
                                                                      
-                    
-                        constructor
-                  
                                                                      
-                
                                                                      
-                
                                                                      
-                  
                                                                      Properties
                                                                      
-                  
                                                                      
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        stack?
-                    
-                        stackTraceLimit
-                  
                                                                      
-                
                                                                      
-                
                                                                      
-                  
                                                                      Methods
                                                                      
-                  
                                                                      
-                    
-                        captureStackTrace
-                    
-                        fromPayload
-                    
-                        prepareStackTrace
-                  
                                                                      
-                
                                                                      
-              
                                                                      
-            
                                                                      
-          
                                                                      
-        
                                                                      
-        
                                                                      
-          
-            
-            
                                                                      Constructors
                                                                      
-                                                                                
-          
                                                                      
-            
                                                                      
-              
-              
                                                                        
-                
                                                                      • 
-                  
-                  
                                                                        
-                    
                                                                        
-                      
                                                                        Parameters
                                                                        
-                      
                                                                          
-                        
                                                                        • 
-                          error:
-                            string
-                        
                                                                          • 
-                        
                                                                        • 
-                          error_description:
-                            string
-                        
                                                                          • 
-                      
                                                                        
-                    
                                                                        
-                    
                                                                        
-                      Returns
-                      MfaEnrollmentFactorsError
-                    
                                                                        
-                    
-                  
                                                                        
-                
                                                                        • 
-              
                                                                      
-            
                                                                      
-          
                                                                      
-        
                                                                      
-        
                                                                      
-          
-            
-            
                                                                      Properties
                                                                      
-                                                                                
-          
                                                                      
-            
                                                                      
-              
-              
                                                                      
-                error:
-                string
-              
                                                                      
-              
-            
                                                                      
-            
                                                                      
-              
-              
                                                                      
-                error_description:
-                string
-              
                                                                      
-              
-            
                                                                      
-            
                                                                      
-              
-              
                                                                      
-                message:
-                string
-              
                                                                      
-              
-            
                                                                      
-            
                                                                      
-              
-              
                                                                      
-                name:
-                string
-              
                                                                      
-              
-            
                                                                      
-            
                                                                      
-              
-              
                                                                      
-                stack?:
-                string
-              
                                                                      
-              
-            
                                                                      
-            
                                                                      
-              
-              
                                                                      
-                stackTraceLimit:
-                number
-              
                                                                      
-              
                                                                      
-                
                                                                      
-                  The Error.stackTraceLimit property specifies the
-                  number of stack frames collected by a stack trace (whether
-                  generated by new Error().stack or
-                  Error.captureStackTrace(obj)).
-                
                                                                      
-                
                                                                      
-                  The default value is 10 but may be set to any
-                  valid JavaScript number. Changes will affect any stack trace
-                  captured after the value has been changed.
-                
                                                                      
-                
                                                                      
-                  If set to a non-number value, or set to a negative number,
-                  stack traces will not capture any frames.
-                
                                                                      
-              
                                                                      
-              
-            
                                                                      
-          
                                                                      
-        
                                                                      
-        
                                                                      
-          
-            
-            
                                                                      Methods
                                                                      
-                                                                                
-          
                                                                      
-            
                                                                      
-              
-              
                                                                        
-                
                                                                      • 
-                  
-                  
                                                                        
-                    
                                                                        
-                      
                                                                        
-                        Creates a .stack property on
-                        targetObject, which when accessed returns a
-                        string representing the location in the code at which
-                        Error.captureStackTrace() was called.
-                      
                                                                        
-                      
                                                                        const myObject = {};
                                                                        Error.captureStackTrace(myObject);
                                                                        myObject.stack;  // Similar to `new Error().stack`
+
+
                                                                      Hierarchy (View Summary)
                                                                      Index
                                                                      Constructors
                                                                      constructor
+
                                                                      Properties
                                                                      error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                                      Methods
                                                                      captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                      Constructors
                                                                      Properties
                                                                      error: string
                                                                      error_description: string
                                                                      message: string
                                                                      name: string
                                                                      stack?: string
                                                                      stackTraceLimit: number
                                                                      The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                      
+
                                                                      The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                      
+
                                                                      If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                      
+
                                                                      Methods
                                                                      • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                        
+
                                                                        const myObject = {};
                                                                        Error.captureStackTrace(myObject);
                                                                        myObject.stack;  // Similar to `new Error().stack`
 
                                                                        
 
-                      
                                                                        
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                        
-                      
                                                                        
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                        
-                      
                                                                        
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                        
-                      
                                                                        function a() {
                                                                          b();
                                                                        }

                                                                        function b() {
                                                                          c();
                                                                        }

                                                                        function c() {
                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                          const { stackTraceLimit } = Error;
                                                                          Error.stackTraceLimit = 0;
                                                                          const error = new Error();
                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                          // Capture the stack trace above function b
                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                          throw error;
                                                                        }

                                                                        a();
+
                                                                        The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                        
+
                                                                        The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                        
+
                                                                        The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                        
+
                                                                        function a() {
                                                                          b();
                                                                        }

                                                                        function b() {
                                                                          c();
                                                                        }

                                                                        function c() {
                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                          const { stackTraceLimit } = Error;
                                                                          Error.stackTraceLimit = 0;
                                                                          const error = new Error();
                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                          // Capture the stack trace above function b
                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                          throw error;
                                                                        }

                                                                        a();
 
                                                                        
-                    
                                                                        
-                    
                                                                        
-                      
                                                                        Parameters
                                                                        
-                      
                                                                          
-                        
                                                                        • 
-                          targetObject:
-                            object
-                        
                                                                          • 
-                        
                                                                        • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                          • 
-                      
                                                                        
-                    
                                                                        
-                    
                                                                        
-                      Returns void
-                    
                                                                        
-                    
-                  
                                                                        
-                
                                                                        • 
-              
                                                                      
-            
                                                                      
-            
                                                                      
-              
-              
                                                                        
-                
                                                                      • 
-                  
-                  
                                                                        
-                    
                                                                        
-                      
                                                                        Parameters
                                                                        
-                      
                                                                          
-                        
                                                                        • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                          • 
-                      
                                                                        
-                    
                                                                        
-                    
                                                                        
-                      Returns
-                      MfaError
-                    
                                                                        
-                    
-                  
                                                                        
-                
                                                                        • 
-              
                                                                      
-            
                                                                      
-            
                                                                      
-              
-              
-            
                                                                      
-          
                                                                      
-        
                                                                      
-      
                                                                      
-      
                                                                      
-        
                                                                      
-          
                                                                      
-            
                                                                      
-              
-                
-                
                                                                      Settings
                                                                      
-                                                                                    
-              
                                                                      
-                
                                                                      
-                  Member Visibility
-                  
                                                                        
-                    
                                                                      • 
-                      
-                    
                                                                        • 
-                    
                                                                      • 
-                      
-                    
                                                                        • 
-                    
                                                                      • 
-                      
-                    
                                                                        • 
-                  
                                                                      
-                
                                                                      
-                
                                                                      
-                  
-                
                                                                      
-              
                                                                      
-            
                                                                      
-          
                                                                      
-          
                                                                      
-            
-              
-              
                                                                      On This Page
                                                                      
-                                                                                  
-            
                                                                      
-              
                                                                      
-                
-                  Constructors
-                
-                
-              
                                                                      
-              
                                                                      
-                
-                  Properties
-                
-                
-              
                                                                      
-              
                                                                      
-                
-                  Methods
-                
-                
-              
                                                                      
-            
                                                                      
-          
                                                                      
-        
                                                                      
-        
                                                                      
-          
-        
                                                                      
-      
                                                                      
-    
                                                                      
-    
                                                                      
-    
                                                                      
-  
-
+
+

                                                                      Parameters

                                                                      • targetObject: object
                                                                      • OptionalconstructorOpt: Function

                                                                      Returns void

                                                                      • Parameters

                                                                        • __namedParameters: { error: string; error_description: string }

                                                                        Returns MfaError

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Constructors
                                                                      Properties
                                                                      Methods
                                                                      diff --git a/docs/classes/MfaError.html b/docs/classes/MfaError.html index a365d19a..8fcbf69b 100644 --- a/docs/classes/MfaError.html +++ b/docs/classes/MfaError.html @@ -1,1259 +1,37 @@ - - - - - - MfaError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                      -
                                                                      - @auth0/auth0-angular - - - - -
                                                                        -
                                                                        -
                                                                        Preparing search index...
                                                                        -
                                                                        -                                                                         - -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        - -

                                                                        Class MfaError

                                                                        -
                                                                        -
                                                                        -
                                                                        -

                                                                        - Base class for MFA-related errors in auth0-spa-js. Extends - GenericError for unified error hierarchy across the SDK. -

                                                                        -
                                                                        -
                                                                        -
                                                                        -

                                                                        - Hierarchy (View Summary) -

                                                                        - -
                                                                        - -
                                                                        -
                                                                        -
                                                                        - - -
                                                                        Index
                                                                        -                                                                         -
                                                                        -
                                                                        -

                                                                        Constructors

                                                                        -
                                                                        - - constructor -
                                                                        -
                                                                        -
                                                                        -

                                                                        Properties

                                                                        -
                                                                        - - error - - error_description - - message - - name - - stack? - - stackTraceLimit -
                                                                        -
                                                                        -
                                                                        -

                                                                        Methods

                                                                        -
                                                                        - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -

                                                                        Constructors

                                                                        -                                                                         -
                                                                        -
                                                                        - -
                                                                          -
                                                                        • - -
                                                                          -
                                                                          -

                                                                          Parameters

                                                                          -
                                                                            -
                                                                          • - error: - string -
                                                                            • -
                                                                          • - error_description: - string -
                                                                            • -
                                                                          -
                                                                          -

                                                                          - Returns - MfaError -

                                                                          - -
                                                                          -
                                                                          • -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -

                                                                        Properties

                                                                        -                                                                         -
                                                                        -
                                                                        - -
                                                                        - error: - string -
                                                                        - -
                                                                        -
                                                                        - -
                                                                        - error_description: - string -
                                                                        - -
                                                                        -
                                                                        - -
                                                                        - message: - string -
                                                                        - -
                                                                        -
                                                                        - -
                                                                        - name: - string -
                                                                        - -
                                                                        -
                                                                        - -
                                                                        - stack?: - string -
                                                                        - -
                                                                        -
                                                                        - -
                                                                        - stackTraceLimit: - number -
                                                                        -
                                                                        -

                                                                        - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                        -

                                                                        - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                        -

                                                                        - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                        -
                                                                        - -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -

                                                                        Methods

                                                                        -                                                                         -
                                                                        -
                                                                        - -
                                                                          -
                                                                        • - -
                                                                          -
                                                                          -

                                                                          - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                          - 
                                                                          const myObject = {};
                                                                          Error.captureStackTrace(myObject);
                                                                          myObject.stack;  // Similar to `new Error().stack`
+MfaError | @auth0/auth0-angular
                                                                          @auth0/auth0-angular
                                                                            Preparing search index...
                                                                            Class MfaError
                                                                            Base class for MFA-related errors in auth0-spa-js.
+Extends GenericError for unified error hierarchy across the SDK.
                                                                            
+
                                                                            Hierarchy (View Summary)
                                                                            Index
                                                                            Constructors
                                                                            constructor
+
                                                                            Properties
                                                                            error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                                            Methods
                                                                            captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                            Constructors
                                                                            • Parameters
                                                                              • error: string
                                                                              • error_description: string
                                                                              Returns MfaError
                                                                            Properties
                                                                            error: string
                                                                            error_description: string
                                                                            message: string
                                                                            name: string
                                                                            stack?: string
                                                                            stackTraceLimit: number
                                                                            The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                            
+
                                                                            The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                            
+
                                                                            If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                            
+
                                                                            Methods
                                                                            • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                              
+
                                                                              const myObject = {};
                                                                              Error.captureStackTrace(myObject);
                                                                              myObject.stack;  // Similar to `new Error().stack`
 
                                                                              
 
-                      
                                                                              
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                              
-                      
                                                                              
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                              
-                      
                                                                              
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                              
-                      
                                                                              function a() {
                                                                                b();
                                                                              }

                                                                              function b() {
                                                                                c();
                                                                              }

                                                                              function c() {
                                                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                const { stackTraceLimit } = Error;
                                                                                Error.stackTraceLimit = 0;
                                                                                const error = new Error();
                                                                                Error.stackTraceLimit = stackTraceLimit;

                                                                                // Capture the stack trace above function b
                                                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                throw error;
                                                                              }

                                                                              a();
+
                                                                              The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                              
+
                                                                              The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                              
+
                                                                              The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                              
+
                                                                              function a() {
                                                                                b();
                                                                              }

                                                                              function b() {
                                                                                c();
                                                                              }

                                                                              function c() {
                                                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                const { stackTraceLimit } = Error;
                                                                                Error.stackTraceLimit = 0;
                                                                                const error = new Error();
                                                                                Error.stackTraceLimit = stackTraceLimit;

                                                                                // Capture the stack trace above function b
                                                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                throw error;
                                                                              }

                                                                              a();
 
                                                                              
-                    
                                                                              
-                    
                                                                              
-                      
                                                                              Parameters
                                                                              
-                      
                                                                                
-                        
                                                                              • 
-                          targetObject:
-                            object
-                        
                                                                                • 
-                        
                                                                              • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                • 
-                      
                                                                              
-                    
                                                                              
-                    
                                                                              
-                      Returns void
-                    
                                                                              
-                    
-                  
                                                                              
-                
                                                                              • 
-              
                                                                            
-            
                                                                            
-            
                                                                            
-              
-              
                                                                              
-                
                                                                            • 
-                  
-                  
                                                                              
-                    
                                                                              
-                      
                                                                              Parameters
                                                                              
-                      
                                                                                
-                        
                                                                              • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                • 
-                      
                                                                              
-                    
                                                                              
-                    
                                                                              
-                      Returns
-                      MfaError
-                    
                                                                              
-                    
-                  
                                                                              
-                
                                                                              • 
-              
                                                                            
-            
                                                                            
-            
                                                                            
-              
-              
-            
                                                                            
-          
                                                                            
-        
                                                                            
-      
                                                                            
-      
                                                                            
-        
                                                                            
-          
                                                                            
-            
                                                                            
-              
-                
-                
                                                                            Settings
                                                                            
-                                                                                          
-              
                                                                            
-                
                                                                            
-                  Member Visibility
-                  
                                                                              
-                    
                                                                            • 
-                      
-                    
                                                                              • 
-                    
                                                                            • 
-                      
-                    
                                                                              • 
-                    
                                                                            • 
-                      
-                    
                                                                              • 
-                  
                                                                            
-                
                                                                            
-                
                                                                            
-                  
-                
                                                                            
-              
                                                                            
-            
                                                                            
-          
                                                                            
-          
                                                                            
-            
-              
-              
                                                                            On This Page
                                                                            
-                                                                                        
-            
                                                                            
-              
                                                                            
-                
-                  Constructors
-                
-                
-              
                                                                            
-              
                                                                            
-                
-                  Properties
-                
-                
-              
                                                                            
-              
                                                                            
-                
-                  Methods
-                
-                
-              
                                                                            
-            
                                                                            
-          
                                                                            
-        
                                                                            
-        
                                                                            
-          
-        
                                                                            
-      
                                                                            
-    
                                                                            
-    
                                                                            
-    
                                                                            
-  
-
+
+

                                                                            Parameters

                                                                            • targetObject: object
                                                                            • OptionalconstructorOpt: Function

                                                                            Returns void

                                                                          • Parameters

                                                                            • __namedParameters: { error: string; error_description: string }

                                                                            Returns MfaError

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Constructors
                                                                          Properties
                                                                          Methods
                                                                          diff --git a/docs/classes/MfaListAuthenticatorsError.html b/docs/classes/MfaListAuthenticatorsError.html index 6bf750ad..d91a66a4 100644 --- a/docs/classes/MfaListAuthenticatorsError.html +++ b/docs/classes/MfaListAuthenticatorsError.html @@ -1,1247 +1,39 @@ - - - - - - MfaListAuthenticatorsError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                          -
                                                                          - @auth0/auth0-angular - - - - -
                                                                            -
                                                                            -
                                                                            Preparing search index...
                                                                            -
                                                                            -                                                                             - -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - -

                                                                            Class MfaListAuthenticatorsError

                                                                            -
                                                                            -
                                                                            -
                                                                            -

                                                                            Error thrown when listing MFA authenticators fails.

                                                                            -
                                                                            -
                                                                            -
                                                                            - - 
                                                                            try {
                                                                              const authenticators = await mfa.getAuthenticators();
                                                                            } catch (error) {
                                                                              if (error instanceof MfaListAuthenticatorsError) {
                                                                                console.log(error.error); // 'access_denied'
                                                                                console.log(error.error_description); // 'Unauthorized'
                                                                              }
                                                                            }
+MfaListAuthenticatorsError | @auth0/auth0-angular
                                                                            @auth0/auth0-angular
                                                                              Preparing search index...
                                                                              Class MfaListAuthenticatorsError
                                                                              Error thrown when listing MFA authenticators fails.
                                                                              
+
                                                                              try {
                                                                                const authenticators = await mfa.getAuthenticators();
                                                                              } catch (error) {
                                                                                if (error instanceof MfaListAuthenticatorsError) {
                                                                                  console.log(error.error); // 'access_denied'
                                                                                  console.log(error.error_description); // 'Unauthorized'
                                                                                }
                                                                              }
 
                                                                              
-            
                                                                              
-          
                                                                              
-        
                                                                              
-        
                                                                              
-          
                                                                              
-            Hierarchy (View Summary)
-          
                                                                              
-          
                                                                                
-            
                                                                              • 
-              MfaError
-              
                                                                                  
-                
                                                                                • 
-                  MfaListAuthenticatorsError
-                
                                                                                  • 
-              
                                                                                
-            
                                                                                • 
-          
                                                                              
-        
                                                                              
-        
-        
                                                                              
-          
                                                                              
-            
                                                                              
-              
-                
-                
                                                                              Index
                                                                              
-                                                                                            
-              
                                                                              
-                
                                                                              
-                  
                                                                              Constructors
                                                                              
-                  
                                                                              
-                    
-                        constructor
-                  
                                                                              
-                
                                                                              
-                
                                                                              
-                  
                                                                              Properties
                                                                              
-                  
                                                                              
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        stack?
-                    
-                        stackTraceLimit
-                  
                                                                              
-                
                                                                              
-                
                                                                              
-                  
                                                                              Methods
                                                                              
-                  
                                                                              
-                    
-                        captureStackTrace
-                    
-                        fromPayload
-                    
-                        prepareStackTrace
-                  
                                                                              
-                
                                                                              
-              
                                                                              
-            
                                                                              
-          
                                                                              
-        
                                                                              
-        
                                                                              
-          
-            
-            
                                                                              Constructors
                                                                              
-                                                                                        
-          
                                                                              
-            
                                                                              
-              
-              
                                                                                
-                
                                                                              • 
-                  
-                  
                                                                                
-                    
                                                                                
-                      
                                                                                Parameters
                                                                                
-                      
                                                                                  
-                        
                                                                                • 
-                          error:
-                            string
-                        
                                                                                  • 
-                        
                                                                                • 
-                          error_description:
-                            string
-                        
                                                                                  • 
-                      
                                                                                
-                    
                                                                                
-                    
                                                                                
-                      Returns
-                      MfaListAuthenticatorsError
-                    
                                                                                
-                    
-                  
                                                                                
-                
                                                                                • 
-              
                                                                              
-            
                                                                              
-          
                                                                              
-        
                                                                              
-        
                                                                              
-          
-            
-            
                                                                              Properties
                                                                              
-                                                                                        
-          
                                                                              
-            
                                                                              
-              
-              
                                                                              
-                error:
-                string
-              
                                                                              
-              
-            
                                                                              
-            
                                                                              
-              
-              
                                                                              
-                error_description:
-                string
-              
                                                                              
-              
-            
                                                                              
-            
                                                                              
-              
-              
                                                                              
-                message:
-                string
-              
                                                                              
-              
-            
                                                                              
-            
                                                                              
-              
-              
                                                                              
-                name:
-                string
-              
                                                                              
-              
-            
                                                                              
-            
                                                                              
-              
-              
                                                                              
-                stack?:
-                string
-              
                                                                              
-              
-            
                                                                              
-            
                                                                              
-              
-              
                                                                              
-                stackTraceLimit:
-                number
-              
                                                                              
-              
                                                                              
-                
                                                                              
-                  The Error.stackTraceLimit property specifies the
-                  number of stack frames collected by a stack trace (whether
-                  generated by new Error().stack or
-                  Error.captureStackTrace(obj)).
-                
                                                                              
-                
                                                                              
-                  The default value is 10 but may be set to any
-                  valid JavaScript number. Changes will affect any stack trace
-                  captured after the value has been changed.
-                
                                                                              
-                
                                                                              
-                  If set to a non-number value, or set to a negative number,
-                  stack traces will not capture any frames.
-                
                                                                              
-              
                                                                              
-              
-            
                                                                              
-          
                                                                              
-        
                                                                              
-        
                                                                              
-          
-            
-            
                                                                              Methods
                                                                              
-                                                                                        
-          
                                                                              
-            
                                                                              
-              
-              
                                                                                
-                
                                                                              • 
-                  
-                  
                                                                                
-                    
                                                                                
-                      
                                                                                
-                        Creates a .stack property on
-                        targetObject, which when accessed returns a
-                        string representing the location in the code at which
-                        Error.captureStackTrace() was called.
-                      
                                                                                
-                      
                                                                                const myObject = {};
                                                                                Error.captureStackTrace(myObject);
                                                                                myObject.stack;  // Similar to `new Error().stack`
+
+
                                                                              Hierarchy (View Summary)
                                                                              Index
                                                                              Constructors
                                                                              constructor
+
                                                                              Properties
                                                                              error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                                              Methods
                                                                              captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                              Constructors
                                                                              Properties
                                                                              error: string
                                                                              error_description: string
                                                                              message: string
                                                                              name: string
                                                                              stack?: string
                                                                              stackTraceLimit: number
                                                                              The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                              
+
                                                                              The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                              
+
                                                                              If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                              
+
                                                                              Methods
                                                                              • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                
+
                                                                                const myObject = {};
                                                                                Error.captureStackTrace(myObject);
                                                                                myObject.stack;  // Similar to `new Error().stack`
 
                                                                                
 
-                      
                                                                                
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                
-                      
                                                                                
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                
-                      
                                                                                
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                
-                      
                                                                                function a() {
                                                                                  b();
                                                                                }

                                                                                function b() {
                                                                                  c();
                                                                                }

                                                                                function c() {
                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                  const { stackTraceLimit } = Error;
                                                                                  Error.stackTraceLimit = 0;
                                                                                  const error = new Error();
                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                  // Capture the stack trace above function b
                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                  throw error;
                                                                                }

                                                                                a();
+
                                                                                The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                
+
                                                                                The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                
+
                                                                                The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                
+
                                                                                function a() {
                                                                                  b();
                                                                                }

                                                                                function b() {
                                                                                  c();
                                                                                }

                                                                                function c() {
                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                  const { stackTraceLimit } = Error;
                                                                                  Error.stackTraceLimit = 0;
                                                                                  const error = new Error();
                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                  // Capture the stack trace above function b
                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                  throw error;
                                                                                }

                                                                                a();
 
                                                                                
-                    
                                                                                
-                    
                                                                                
-                      
                                                                                Parameters
                                                                                
-                      
                                                                                  
-                        
                                                                                • 
-                          targetObject:
-                            object
-                        
                                                                                  • 
-                        
                                                                                • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                  • 
-                      
                                                                                
-                    
                                                                                
-                    
                                                                                
-                      Returns void
-                    
                                                                                
-                    
-                  
                                                                                
-                
                                                                                • 
-              
                                                                              
-            
                                                                              
-            
                                                                              
-              
-              
                                                                                
-                
                                                                              • 
-                  
-                  
                                                                                
-                    
                                                                                
-                      
                                                                                Parameters
                                                                                
-                      
                                                                                  
-                        
                                                                                • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                  • 
-                      
                                                                                
-                    
                                                                                
-                    
                                                                                
-                      Returns
-                      MfaError
-                    
                                                                                
-                    
-                  
                                                                                
-                
                                                                                • 
-              
                                                                              
-            
                                                                              
-            
                                                                              
-              
-              
-            
                                                                              
-          
                                                                              
-        
                                                                              
-      
                                                                              
-      
                                                                              
-        
                                                                              
-          
                                                                              
-            
                                                                              
-              
-                
-                
                                                                              Settings
                                                                              
-                                                                                            
-              
                                                                              
-                
                                                                              
-                  Member Visibility
-                  
                                                                                
-                    
                                                                              • 
-                      
-                    
                                                                                • 
-                    
                                                                              • 
-                      
-                    
                                                                                • 
-                    
                                                                              • 
-                      
-                    
                                                                                • 
-                  
                                                                              
-                
                                                                              
-                
                                                                              
-                  
-                
                                                                              
-              
                                                                              
-            
                                                                              
-          
                                                                              
-          
                                                                              
-            
-              
-              
                                                                              On This Page
                                                                              
-                                                                                          
-            
                                                                              
-              
                                                                              
-                
-                  Constructors
-                
-                
-              
                                                                              
-              
                                                                              
-                
-                  Properties
-                
-                
-              
                                                                              
-              
                                                                              
-                
-                  Methods
-                
-                
-              
                                                                              
-            
                                                                              
-          
                                                                              
-        
                                                                              
-        
                                                                              
-          
-        
                                                                              
-      
                                                                              
-    
                                                                              
-    
                                                                              
-    
                                                                              
-  
-
+
+

                                                                              Parameters

                                                                              • targetObject: object
                                                                              • OptionalconstructorOpt: Function

                                                                              Returns void

                                                                              • Parameters

                                                                                • __namedParameters: { error: string; error_description: string }

                                                                                Returns MfaError

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Constructors
                                                                              Properties
                                                                              Methods
                                                                              diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index d013fe42..bed3ce44 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,1349 +1,38 @@ - - - - - - MfaRequiredError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                              -
                                                                              - @auth0/auth0-angular - - - - -
                                                                                -
                                                                                -
                                                                                Preparing search index...
                                                                                -
                                                                                -                                                                                 - -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                - -

                                                                                Class MfaRequiredError

                                                                                -
                                                                                -
                                                                                -
                                                                                -

                                                                                - Error thrown when the token exchange results in a - mfa_required error -

                                                                                -
                                                                                -
                                                                                -
                                                                                -

                                                                                - Hierarchy (View Summary) -

                                                                                - -
                                                                                - -
                                                                                -
                                                                                -
                                                                                - - -
                                                                                Index
                                                                                -                                                                                 -
                                                                                -
                                                                                -

                                                                                Constructors

                                                                                -
                                                                                - - constructor -
                                                                                -
                                                                                -
                                                                                -

                                                                                Properties

                                                                                -
                                                                                - - error - - error_description - - message - - mfa_requirements - - mfa_token - - name - - stack? - - stackTraceLimit -
                                                                                -
                                                                                -
                                                                                -

                                                                                Methods

                                                                                -
                                                                                - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -

                                                                                Constructors

                                                                                -                                                                                 -
                                                                                -
                                                                                - -
                                                                                  -
                                                                                • - -
                                                                                  -
                                                                                  -

                                                                                  Parameters

                                                                                  -
                                                                                    -
                                                                                  • - error: - string -
                                                                                    • -
                                                                                  • - error_description: - string -
                                                                                    • -
                                                                                  • - mfa_token: - string -
                                                                                    • -
                                                                                  • - mfa_requirements: - MfaRequirements -
                                                                                    • -
                                                                                  -
                                                                                  -

                                                                                  - Returns - MfaRequiredError -

                                                                                  - -
                                                                                  -
                                                                                  • -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -

                                                                                Properties

                                                                                -                                                                                 -
                                                                                -
                                                                                - -
                                                                                - error: - string -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                - error_description: - string -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                - message: - string -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                - mfa_requirements: - MfaRequirements -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                - mfa_token: - string -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                - name: - string -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                - stack?: - string -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                - stackTraceLimit: - number -
                                                                                -
                                                                                -

                                                                                - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                                -

                                                                                - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                                -

                                                                                - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                                -
                                                                                - -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -

                                                                                Methods

                                                                                -                                                                                 -
                                                                                -
                                                                                - -
                                                                                  -
                                                                                • - -
                                                                                  -
                                                                                  -

                                                                                  - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                                  - 
                                                                                  const myObject = {};
                                                                                  Error.captureStackTrace(myObject);
                                                                                  myObject.stack;  // Similar to `new Error().stack`
+MfaRequiredError | @auth0/auth0-angular
                                                                                  @auth0/auth0-angular
                                                                                    Preparing search index...
                                                                                    Class MfaRequiredError
                                                                                    Error thrown when the token exchange results in a mfa_required error
                                                                                    
+
                                                                                    Hierarchy (View Summary)
                                                                                    Index
                                                                                    Constructors
                                                                                    constructor
+
                                                                                    Properties
                                                                                    error
+error_description
+message
+mfa_requirements
+mfa_token
+name
+stack?
+stackTraceLimit
+
                                                                                    Methods
                                                                                    captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                    Constructors
                                                                                    • Parameters
                                                                                      • error: string
                                                                                      • error_description: string
                                                                                      • mfa_token: string
                                                                                      • mfa_requirements: MfaRequirements
                                                                                      Returns MfaRequiredError
                                                                                    Properties
                                                                                    error: string
                                                                                    error_description: string
                                                                                    message: string
                                                                                    mfa_requirements: MfaRequirements
                                                                                    mfa_token: string
                                                                                    name: string
                                                                                    stack?: string
                                                                                    stackTraceLimit: number
                                                                                    The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                    
+
                                                                                    The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                    
+
                                                                                    If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                    
+
                                                                                    Methods
                                                                                    • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                      
+
                                                                                      const myObject = {};
                                                                                      Error.captureStackTrace(myObject);
                                                                                      myObject.stack;  // Similar to `new Error().stack`
 
                                                                                      
 
-                      
                                                                                      
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                      
-                      
                                                                                      
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                      
-                      
                                                                                      
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                      
-                      
                                                                                      function a() {
                                                                                        b();
                                                                                      }

                                                                                      function b() {
                                                                                        c();
                                                                                      }

                                                                                      function c() {
                                                                                        // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                        const { stackTraceLimit } = Error;
                                                                                        Error.stackTraceLimit = 0;
                                                                                        const error = new Error();
                                                                                        Error.stackTraceLimit = stackTraceLimit;

                                                                                        // Capture the stack trace above function b
                                                                                        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                        throw error;
                                                                                      }

                                                                                      a();
+
                                                                                      The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                      
+
                                                                                      The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                      
+
                                                                                      The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                      
+
                                                                                      function a() {
                                                                                        b();
                                                                                      }

                                                                                      function b() {
                                                                                        c();
                                                                                      }

                                                                                      function c() {
                                                                                        // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                        const { stackTraceLimit } = Error;
                                                                                        Error.stackTraceLimit = 0;
                                                                                        const error = new Error();
                                                                                        Error.stackTraceLimit = stackTraceLimit;

                                                                                        // Capture the stack trace above function b
                                                                                        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                        throw error;
                                                                                      }

                                                                                      a();
 
                                                                                      
-                    
                                                                                      
-                    
                                                                                      
-                      
                                                                                      Parameters
                                                                                      
-                      
                                                                                        
-                        
                                                                                      • 
-                          targetObject:
-                            object
-                        
                                                                                        • 
-                        
                                                                                      • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                        • 
-                      
                                                                                      
-                    
                                                                                      
-                    
                                                                                      
-                      Returns void
-                    
                                                                                      
-                    
-                  
                                                                                      
-                
                                                                                      • 
-              
                                                                                    
-            
                                                                                    
-            
                                                                                    
-              
-              
                                                                                      
-                
                                                                                    • 
-                  
-                  
                                                                                      
-                    
                                                                                      
-                      
                                                                                      Parameters
                                                                                      
-                      
                                                                                        
-                        
                                                                                      • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                        • 
-                      
                                                                                      
-                    
                                                                                      
-                    
                                                                                      
-                      Returns
-                      GenericError
-                    
                                                                                      
-                    
-                  
                                                                                      
-                
                                                                                      • 
-              
                                                                                    
-            
                                                                                    
-            
                                                                                    
-              
-              
-            
                                                                                    
-          
                                                                                    
-        
                                                                                    
-      
                                                                                    
-      
                                                                                    
-        
                                                                                    
-          
                                                                                    
-            
                                                                                    
-              
-                
-                
                                                                                    Settings
                                                                                    
-                                                                                                  
-              
                                                                                    
-                
                                                                                    
-                  Member Visibility
-                  
                                                                                      
-                    
                                                                                    • 
-                      
-                    
                                                                                      • 
-                    
                                                                                    • 
-                      
-                    
                                                                                      • 
-                    
                                                                                    • 
-                      
-                    
                                                                                      • 
-                  
                                                                                    
-                
                                                                                    
-                
                                                                                    
-                  
-                
                                                                                    
-              
                                                                                    
-            
                                                                                    
-          
                                                                                    
-          
                                                                                    
-            
-              
-              
                                                                                    On This Page
                                                                                    
-                                                                                                
-            
                                                                                    
-              
                                                                                    
-                
-                  Constructors
-                
-                
-              
                                                                                    
-              
                                                                                    
-                
-                  Properties
-                
-                
-              
                                                                                    
-              
                                                                                    
-                
-                  Methods
-                
-                
-              
                                                                                    
-            
                                                                                    
-          
                                                                                    
-        
                                                                                    
-        
                                                                                    
-          
-        
                                                                                    
-      
                                                                                    
-    
                                                                                    
-    
                                                                                    
-    
                                                                                    
-  
-
+
+

                                                                                    Parameters

                                                                                    • targetObject: object
                                                                                    • OptionalconstructorOpt: Function

                                                                                    Returns void

                                                                                  • Parameters

                                                                                    • __namedParameters: { error: string; error_description: string }

                                                                                    Returns GenericError

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Constructors
                                                                                  Properties
                                                                                  Methods
                                                                                  diff --git a/docs/classes/MfaVerifyError.html b/docs/classes/MfaVerifyError.html index dceef267..489e17b0 100644 --- a/docs/classes/MfaVerifyError.html +++ b/docs/classes/MfaVerifyError.html @@ -1,1239 +1,39 @@ - - - - - - MfaVerifyError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                  -
                                                                                  - @auth0/auth0-angular - - - - -
                                                                                    -
                                                                                    -
                                                                                    Preparing search index...
                                                                                    -
                                                                                    -                                                                                     - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - -

                                                                                    Class MfaVerifyError

                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -

                                                                                    Error thrown when verifying an MFA challenge fails.

                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - 
                                                                                    try {
                                                                                      const tokens = await mfa.verify({
                                                                                        mfaToken: mfaToken,
                                                                                        grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
                                                                                        otp: '123456'
                                                                                      });
                                                                                    } catch (error) {
                                                                                      if (error instanceof MfaVerifyError) {
                                                                                        console.log(error.error); // 'invalid_otp' or 'context_not_found'
                                                                                        console.log(error.error_description); // Error details
                                                                                      }
                                                                                    }
+MfaVerifyError | @auth0/auth0-angular
                                                                                    @auth0/auth0-angular
                                                                                      Preparing search index...
                                                                                      Class MfaVerifyError
                                                                                      Error thrown when verifying an MFA challenge fails.
                                                                                      
+
                                                                                      try {
                                                                                        const tokens = await mfa.verify({
                                                                                          mfaToken: mfaToken,
                                                                                          grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
                                                                                          otp: '123456'
                                                                                        });
                                                                                      } catch (error) {
                                                                                        if (error instanceof MfaVerifyError) {
                                                                                          console.log(error.error); // 'invalid_otp' or 'context_not_found'
                                                                                          console.log(error.error_description); // Error details
                                                                                        }
                                                                                      }
 
                                                                                      
-            
                                                                                      
-          
                                                                                      
-        
                                                                                      
-        
                                                                                      
-          
                                                                                      
-            Hierarchy (View Summary)
-          
                                                                                      
-          
                                                                                        
-            
                                                                                      • 
-              MfaError
-              
                                                                                          
-                
                                                                                        • 
-                  MfaVerifyError
-                
                                                                                          • 
-              
                                                                                        
-            
                                                                                        • 
-          
                                                                                      
-        
                                                                                      
-        
-        
                                                                                      
-          
                                                                                      
-            
                                                                                      
-              
-                
-                
                                                                                      Index
                                                                                      
-                                                                                                    
-              
                                                                                      
-                
                                                                                      
-                  
                                                                                      Constructors
                                                                                      
-                  
                                                                                      
-                    
-                        constructor
-                  
                                                                                      
-                
                                                                                      
-                
                                                                                      
-                  
                                                                                      Properties
                                                                                      
-                  
                                                                                      
-                    
-                        error
-                    
-                        error_description
-                    
-                        message
-                    
-                        name
-                    
-                        stack?
-                    
-                        stackTraceLimit
-                  
                                                                                      
-                
                                                                                      
-                
                                                                                      
-                  
                                                                                      Methods
                                                                                      
-                  
                                                                                      
-                    
-                        captureStackTrace
-                    
-                        fromPayload
-                    
-                        prepareStackTrace
-                  
                                                                                      
-                
                                                                                      
-              
                                                                                      
-            
                                                                                      
-          
                                                                                      
-        
                                                                                      
-        
                                                                                      
-          
-            
-            
                                                                                      Constructors
                                                                                      
-                                                                                                
-          
                                                                                      
-            
                                                                                      
-              
-              
                                                                                        
-                
                                                                                      • 
-                  
-                  
                                                                                        
-                    
                                                                                        
-                      
                                                                                        Parameters
                                                                                        
-                      
                                                                                          
-                        
                                                                                        • 
-                          error:
-                            string
-                        
                                                                                          • 
-                        
                                                                                        • 
-                          error_description:
-                            string
-                        
                                                                                          • 
-                      
                                                                                        
-                    
                                                                                        
-                    
                                                                                        
-                      Returns
-                      MfaVerifyError
-                    
                                                                                        
-                    
-                  
                                                                                        
-                
                                                                                        • 
-              
                                                                                      
-            
                                                                                      
-          
                                                                                      
-        
                                                                                      
-        
                                                                                      
-          
-            
-            
                                                                                      Properties
                                                                                      
-                                                                                                
-          
                                                                                      
-            
                                                                                      
-              
-              
                                                                                      
-                error:
-                string
-              
                                                                                      
-              
-            
                                                                                      
-            
                                                                                      
-              
-              
                                                                                      
-                error_description:
-                string
-              
                                                                                      
-              
-            
                                                                                      
-            
                                                                                      
-              
-              
                                                                                      
-                message:
-                string
-              
                                                                                      
-              
-            
                                                                                      
-            
                                                                                      
-              
-              
                                                                                      
-                name:
-                string
-              
                                                                                      
-              
-            
                                                                                      
-            
                                                                                      
-              
-              
                                                                                      
-                stack?:
-                string
-              
                                                                                      
-              
-            
                                                                                      
-            
                                                                                      
-              
-              
                                                                                      
-                stackTraceLimit:
-                number
-              
                                                                                      
-              
                                                                                      
-                
                                                                                      
-                  The Error.stackTraceLimit property specifies the
-                  number of stack frames collected by a stack trace (whether
-                  generated by new Error().stack or
-                  Error.captureStackTrace(obj)).
-                
                                                                                      
-                
                                                                                      
-                  The default value is 10 but may be set to any
-                  valid JavaScript number. Changes will affect any stack trace
-                  captured after the value has been changed.
-                
                                                                                      
-                
                                                                                      
-                  If set to a non-number value, or set to a negative number,
-                  stack traces will not capture any frames.
-                
                                                                                      
-              
                                                                                      
-              
-            
                                                                                      
-          
                                                                                      
-        
                                                                                      
-        
                                                                                      
-          
-            
-            
                                                                                      Methods
                                                                                      
-                                                                                                
-          
                                                                                      
-            
                                                                                      
-              
-              
                                                                                        
-                
                                                                                      • 
-                  
-                  
                                                                                        
-                    
                                                                                        
-                      
                                                                                        
-                        Creates a .stack property on
-                        targetObject, which when accessed returns a
-                        string representing the location in the code at which
-                        Error.captureStackTrace() was called.
-                      
                                                                                        
-                      
                                                                                        const myObject = {};
                                                                                        Error.captureStackTrace(myObject);
                                                                                        myObject.stack;  // Similar to `new Error().stack`
+
+
                                                                                      Hierarchy (View Summary)
                                                                                      Index
                                                                                      Constructors
                                                                                      constructor
+
                                                                                      Properties
                                                                                      error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                                                      Methods
                                                                                      captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                      Constructors
                                                                                      • Parameters
                                                                                        • error: string
                                                                                        • error_description: string
                                                                                        Returns MfaVerifyError
                                                                                      Properties
                                                                                      error: string
                                                                                      error_description: string
                                                                                      message: string
                                                                                      name: string
                                                                                      stack?: string
                                                                                      stackTraceLimit: number
                                                                                      The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                      
+
                                                                                      The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                      
+
                                                                                      If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                      
+
                                                                                      Methods
                                                                                      • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                        
+
                                                                                        const myObject = {};
                                                                                        Error.captureStackTrace(myObject);
                                                                                        myObject.stack;  // Similar to `new Error().stack`
 
                                                                                        
 
-                      
                                                                                        
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                        
-                      
                                                                                        
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                        
-                      
                                                                                        
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                        
-                      
                                                                                        function a() {
                                                                                          b();
                                                                                        }

                                                                                        function b() {
                                                                                          c();
                                                                                        }

                                                                                        function c() {
                                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                          const { stackTraceLimit } = Error;
                                                                                          Error.stackTraceLimit = 0;
                                                                                          const error = new Error();
                                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                                          // Capture the stack trace above function b
                                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                          throw error;
                                                                                        }

                                                                                        a();
+
                                                                                        The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                        
+
                                                                                        The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                        
+
                                                                                        The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                        
+
                                                                                        function a() {
                                                                                          b();
                                                                                        }

                                                                                        function b() {
                                                                                          c();
                                                                                        }

                                                                                        function c() {
                                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                          const { stackTraceLimit } = Error;
                                                                                          Error.stackTraceLimit = 0;
                                                                                          const error = new Error();
                                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                                          // Capture the stack trace above function b
                                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                          throw error;
                                                                                        }

                                                                                        a();
 
                                                                                        
-                    
                                                                                        
-                    
                                                                                        
-                      
                                                                                        Parameters
                                                                                        
-                      
                                                                                          
-                        
                                                                                        • 
-                          targetObject:
-                            object
-                        
                                                                                          • 
-                        
                                                                                        • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                          • 
-                      
                                                                                        
-                    
                                                                                        
-                    
                                                                                        
-                      Returns void
-                    
                                                                                        
-                    
-                  
                                                                                        
-                
                                                                                        • 
-              
                                                                                      
-            
                                                                                      
-            
                                                                                      
-              
-              
                                                                                        
-                
                                                                                      • 
-                  
-                  
                                                                                        
-                    
                                                                                        
-                      
                                                                                        Parameters
                                                                                        
-                      
                                                                                          
-                        
                                                                                        • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                          • 
-                      
                                                                                        
-                    
                                                                                        
-                    
                                                                                        
-                      Returns
-                      MfaError
-                    
                                                                                        
-                    
-                  
                                                                                        
-                
                                                                                        • 
-              
                                                                                      
-            
                                                                                      
-            
                                                                                      
-              
-              
-            
                                                                                      
-          
                                                                                      
-        
                                                                                      
-      
                                                                                      
-      
                                                                                      
-        
                                                                                      
-          
                                                                                      
-            
                                                                                      
-              
-                
-                
                                                                                      Settings
                                                                                      
-                                                                                                    
-              
                                                                                      
-                
                                                                                      
-                  Member Visibility
-                  
                                                                                        
-                    
                                                                                      • 
-                      
-                    
                                                                                        • 
-                    
                                                                                      • 
-                      
-                    
                                                                                        • 
-                    
                                                                                      • 
-                      
-                    
                                                                                        • 
-                  
                                                                                      
-                
                                                                                      
-                
                                                                                      
-                  
-                
                                                                                      
-              
                                                                                      
-            
                                                                                      
-          
                                                                                      
-          
                                                                                      
-            
-              
-              
                                                                                      On This Page
                                                                                      
-                                                                                                  
-            
                                                                                      
-              
                                                                                      
-                
-                  Constructors
-                
-                
-              
                                                                                      
-              
                                                                                      
-                
-                  Properties
-                
-                
-              
                                                                                      
-              
                                                                                      
-                
-                  Methods
-                
-                
-              
                                                                                      
-            
                                                                                      
-          
                                                                                      
-        
                                                                                      
-        
                                                                                      
-          
-        
                                                                                      
-      
                                                                                      
-    
                                                                                      
-    
                                                                                      
-    
                                                                                      
-  
-
+
+

                                                                                      Parameters

                                                                                      • targetObject: object
                                                                                      • OptionalconstructorOpt: Function

                                                                                      Returns void

                                                                                      • Parameters

                                                                                        • __namedParameters: { error: string; error_description: string }

                                                                                        Returns MfaError

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Constructors
                                                                                      Properties
                                                                                      Methods
                                                                                      diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index fcb9f15f..0171d15b 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,1315 +1,38 @@ - - - - - - MissingRefreshTokenError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                      -
                                                                                      - @auth0/auth0-angular - - - - -
                                                                                        -
                                                                                        -
                                                                                        Preparing search index...
                                                                                        -
                                                                                        -                                                                                         - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - -

                                                                                        Class MissingRefreshTokenError

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Error thrown when there is no refresh token to use

                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        - Hierarchy (View Summary) -

                                                                                        - -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        Index
                                                                                        -                                                                                         -
                                                                                        -
                                                                                        -

                                                                                        Constructors

                                                                                        -
                                                                                        - - constructor -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Properties

                                                                                        -
                                                                                        - - audience - - error - - error_description - - message - - name - - scope - - stack? - - stackTraceLimit -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Methods

                                                                                        -
                                                                                        - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -

                                                                                        Constructors

                                                                                        -                                                                                         -
                                                                                        -
                                                                                        - -
                                                                                          -
                                                                                        • - -
                                                                                          -
                                                                                          -

                                                                                          Parameters

                                                                                          -
                                                                                            -
                                                                                          • - audience: - string -
                                                                                            • -
                                                                                          • - scope: - string -
                                                                                            • -
                                                                                          -
                                                                                          -

                                                                                          - Returns - MissingRefreshTokenError -

                                                                                          - -
                                                                                          -
                                                                                          • -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -

                                                                                        Properties

                                                                                        -                                                                                         -
                                                                                        -
                                                                                        - -
                                                                                        - audience: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - error: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - error_description: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - message: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - name: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - scope: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - stack?: - string -
                                                                                        - -
                                                                                        -
                                                                                        - -
                                                                                        - stackTraceLimit: - number -
                                                                                        -
                                                                                        -

                                                                                        - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                                        -

                                                                                        - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                                        -

                                                                                        - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -

                                                                                        Methods

                                                                                        -                                                                                         -
                                                                                        -
                                                                                        - -
                                                                                          -
                                                                                        • - -
                                                                                          -
                                                                                          -

                                                                                          - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                                          - 
                                                                                          const myObject = {};
                                                                                          Error.captureStackTrace(myObject);
                                                                                          myObject.stack;  // Similar to `new Error().stack`
+MissingRefreshTokenError | @auth0/auth0-angular
                                                                                          @auth0/auth0-angular
                                                                                            Preparing search index...
                                                                                            Class MissingRefreshTokenError
                                                                                            Error thrown when there is no refresh token to use
                                                                                            
+
                                                                                            Hierarchy (View Summary)
                                                                                            Index
                                                                                            Constructors
                                                                                            constructor
+
                                                                                            Properties
                                                                                            audience
+error
+error_description
+message
+name
+scope
+stack?
+stackTraceLimit
+
                                                                                            Methods
                                                                                            captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                            Constructors
                                                                                            Properties
                                                                                            audience: string
                                                                                            error: string
                                                                                            error_description: string
                                                                                            message: string
                                                                                            name: string
                                                                                            scope: string
                                                                                            stack?: string
                                                                                            stackTraceLimit: number
                                                                                            The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                            
+
                                                                                            The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                            
+
                                                                                            If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                            
+
                                                                                            Methods
                                                                                            • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                              
+
                                                                                              const myObject = {};
                                                                                              Error.captureStackTrace(myObject);
                                                                                              myObject.stack;  // Similar to `new Error().stack`
 
                                                                                              
 
-                      
                                                                                              
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                              
-                      
                                                                                              
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                              
-                      
                                                                                              
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                              
-                      
                                                                                              function a() {
                                                                                                b();
                                                                                              }

                                                                                              function b() {
                                                                                                c();
                                                                                              }

                                                                                              function c() {
                                                                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                const { stackTraceLimit } = Error;
                                                                                                Error.stackTraceLimit = 0;
                                                                                                const error = new Error();
                                                                                                Error.stackTraceLimit = stackTraceLimit;

                                                                                                // Capture the stack trace above function b
                                                                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                throw error;
                                                                                              }

                                                                                              a();
+
                                                                                              The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                              
+
                                                                                              The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                              
+
                                                                                              The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                              
+
                                                                                              function a() {
                                                                                                b();
                                                                                              }

                                                                                              function b() {
                                                                                                c();
                                                                                              }

                                                                                              function c() {
                                                                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                const { stackTraceLimit } = Error;
                                                                                                Error.stackTraceLimit = 0;
                                                                                                const error = new Error();
                                                                                                Error.stackTraceLimit = stackTraceLimit;

                                                                                                // Capture the stack trace above function b
                                                                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                throw error;
                                                                                              }

                                                                                              a();
 
                                                                                              
-                    
                                                                                              
-                    
                                                                                              
-                      
                                                                                              Parameters
                                                                                              
-                      
                                                                                                
-                        
                                                                                              • 
-                          targetObject:
-                            object
-                        
                                                                                                • 
-                        
                                                                                              • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                                • 
-                      
                                                                                              
-                    
                                                                                              
-                    
                                                                                              
-                      Returns void
-                    
                                                                                              
-                    
-                  
                                                                                              
-                
                                                                                              • 
-              
                                                                                            
-            
                                                                                            
-            
                                                                                            
-              
-              
                                                                                              
-                
                                                                                            • 
-                  
-                  
                                                                                              
-                    
                                                                                              
-                      
                                                                                              Parameters
                                                                                              
-                      
                                                                                                
-                        
                                                                                              • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                                • 
-                      
                                                                                              
-                    
                                                                                              
-                    
                                                                                              
-                      Returns
-                      GenericError
-                    
                                                                                              
-                    
-                  
                                                                                              
-                
                                                                                              • 
-              
                                                                                            
-            
                                                                                            
-            
                                                                                            
-              
-              
-            
                                                                                            
-          
                                                                                            
-        
                                                                                            
-      
                                                                                            
-      
                                                                                            
-        
                                                                                            
-          
                                                                                            
-            
                                                                                            
-              
-                
-                
                                                                                            Settings
                                                                                            
-                                                                                                          
-              
                                                                                            
-                
                                                                                            
-                  Member Visibility
-                  
                                                                                              
-                    
                                                                                            • 
-                      
-                    
                                                                                              • 
-                    
                                                                                            • 
-                      
-                    
                                                                                              • 
-                    
                                                                                            • 
-                      
-                    
                                                                                              • 
-                  
                                                                                            
-                
                                                                                            
-                
                                                                                            
-                  
-                
                                                                                            
-              
                                                                                            
-            
                                                                                            
-          
                                                                                            
-          
                                                                                            
-            
-              
-              
                                                                                            On This Page
                                                                                            
-                                                                                                        
-            
                                                                                            
-              
                                                                                            
-                
-                  Constructors
-                
-                
-              
                                                                                            
-              
                                                                                            
-                
-                  Properties
-                
-                
-              
                                                                                            
-              
                                                                                            
-                
-                  Methods
-                
-                
-              
                                                                                            
-            
                                                                                            
-          
                                                                                            
-        
                                                                                            
-        
                                                                                            
-          
-        
                                                                                            
-      
                                                                                            
-    
                                                                                            
-    
                                                                                            
-    
                                                                                            
-  
-
+
+

                                                                                            Parameters

                                                                                            • targetObject: object
                                                                                            • OptionalconstructorOpt: Function

                                                                                            Returns void

                                                                                          • Parameters

                                                                                            • __namedParameters: { error: string; error_description: string }

                                                                                            Returns GenericError

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Constructors
                                                                                          Properties
                                                                                          Methods
                                                                                          diff --git a/docs/classes/MyAccountApiError.html b/docs/classes/MyAccountApiError.html new file mode 100644 index 00000000..b56a7283 --- /dev/null +++ b/docs/classes/MyAccountApiError.html @@ -0,0 +1,46 @@ +MyAccountApiError | @auth0/auth0-angular
                                                                                          @auth0/auth0-angular
                                                                                            Preparing search index...

                                                                                            Class MyAccountApiError

                                                                                            Error thrown when the MyAccount API returns a non-2xx response.

                                                                                            +
                                                                                            try {
                                                                                              await myAccount.getAuthenticationMethods();
                                                                                            } catch (err) {
                                                                                              if (err instanceof MyAccountApiError) {
                                                                                                console.error(err.status, err.title, err.detail);
                                                                                              }
                                                                                            }
+
                                                                                            + +

                                                                                            Hierarchy

                                                                                            • Error
                                                                                              • MyAccountApiError
                                                                                            Index

                                                                                            Constructors

                                                                                            constructor +

                                                                                            Properties

                                                                                            detail +message +name +stack? +status +title +type +validation_errors? +stackTraceLimit +

                                                                                            Methods

                                                                                            captureStackTrace +prepareStackTrace +

                                                                                            Constructors

                                                                                            • Parameters

                                                                                              • __namedParameters: ErrorResponse

                                                                                              Returns MyAccountApiError

                                                                                            Properties

                                                                                            detail: string

                                                                                            Human-readable explanation specific to this occurrence

                                                                                            +
                                                                                            message: string
                                                                                            name: string
                                                                                            stack?: string
                                                                                            status: number

                                                                                            HTTP status code

                                                                                            +
                                                                                            title: string

                                                                                            Short human-readable summary of the error

                                                                                            +
                                                                                            type: string

                                                                                            RFC 7807 error type identifier

                                                                                            +
                                                                                            validation_errors?: {
                                                                                                detail: string;
                                                                                                field?: string;
                                                                                                pointer?: string;
                                                                                                source?: string;
                                                                                            }[]

                                                                                            Field-level validation errors, if present

                                                                                            +
                                                                                            stackTraceLimit: number

                                                                                            The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                                                                                            +

                                                                                            The default value is 10 but may be set to any valid JavaScript number. Changes +will affect any stack trace captured after the value has been changed.

                                                                                            +

                                                                                            If set to a non-number value, or set to a negative number, stack traces will +not capture any frames.

                                                                                            +

                                                                                            Methods

                                                                                            • Creates a .stack property on targetObject, which when accessed returns +a string representing the location in the code at which +Error.captureStackTrace() was called.

                                                                                              +
                                                                                              const myObject = {};
                                                                                              Error.captureStackTrace(myObject);
                                                                                              myObject.stack;  // Similar to `new Error().stack`
+
                                                                                              + +

                                                                                              The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                              +

                                                                                              The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                              +

                                                                                              The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                              +
                                                                                              function a() {
                                                                                                b();
                                                                                              }

                                                                                              function b() {
                                                                                                c();
                                                                                              }

                                                                                              function c() {
                                                                                                // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                const { stackTraceLimit } = Error;
                                                                                                Error.stackTraceLimit = 0;
                                                                                                const error = new Error();
                                                                                                Error.stackTraceLimit = stackTraceLimit;

                                                                                                // Capture the stack trace above function b
                                                                                                Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                throw error;
                                                                                              }

                                                                                              a();
+
                                                                                              + +

                                                                                              Parameters

                                                                                              • targetObject: object
                                                                                              • OptionalconstructorOpt: Function

                                                                                              Returns void

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Constructors
                                                                                            Properties
                                                                                            Methods
                                                                                            diff --git a/docs/classes/PasskeyChallengeError.html b/docs/classes/PasskeyChallengeError.html new file mode 100644 index 00000000..28a3b047 --- /dev/null +++ b/docs/classes/PasskeyChallengeError.html @@ -0,0 +1,35 @@ +PasskeyChallengeError | @auth0/auth0-angular
                                                                                            @auth0/auth0-angular
                                                                                              Preparing search index...

                                                                                              Class PasskeyChallengeError

                                                                                              Error thrown when requesting a passkey login challenge fails.

                                                                                              +

                                                                                              Hierarchy

                                                                                              • PasskeyError
                                                                                                • PasskeyChallengeError
                                                                                              Index

                                                                                              Constructors

                                                                                              constructor +

                                                                                              Properties

                                                                                              cause? +code +message +name +stack? +stackTraceLimit +

                                                                                              Methods

                                                                                              captureStackTrace +prepareStackTrace +

                                                                                              Constructors

                                                                                              • Parameters

                                                                                                • message: string
                                                                                                • Optionalcause: PasskeyApiErrorResponse

                                                                                                Returns PasskeyChallengeError

                                                                                              Properties

                                                                                              cause?: PasskeyApiErrorResponse
                                                                                              code: string
                                                                                              message: string
                                                                                              name: string
                                                                                              stack?: string
                                                                                              stackTraceLimit: number

                                                                                              The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                                                                                              +

                                                                                              The default value is 10 but may be set to any valid JavaScript number. Changes +will affect any stack trace captured after the value has been changed.

                                                                                              +

                                                                                              If set to a non-number value, or set to a negative number, stack traces will +not capture any frames.

                                                                                              +

                                                                                              Methods

                                                                                              • Creates a .stack property on targetObject, which when accessed returns +a string representing the location in the code at which +Error.captureStackTrace() was called.

                                                                                                +
                                                                                                const myObject = {};
                                                                                                Error.captureStackTrace(myObject);
                                                                                                myObject.stack;  // Similar to `new Error().stack`
+
                                                                                                + +

                                                                                                The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                +

                                                                                                The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                +

                                                                                                The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                +
                                                                                                function a() {
                                                                                                  b();
                                                                                                }

                                                                                                function b() {
                                                                                                  c();
                                                                                                }

                                                                                                function c() {
                                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                  const { stackTraceLimit } = Error;
                                                                                                  Error.stackTraceLimit = 0;
                                                                                                  const error = new Error();
                                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                                  // Capture the stack trace above function b
                                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                  throw error;
                                                                                                }

                                                                                                a();
+
                                                                                                + +

                                                                                                Parameters

                                                                                                • targetObject: object
                                                                                                • OptionalconstructorOpt: Function

                                                                                                Returns void

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Constructors
                                                                                              Properties
                                                                                              Methods
                                                                                              diff --git a/docs/classes/PasskeyError.html b/docs/classes/PasskeyError.html new file mode 100644 index 00000000..80912238 --- /dev/null +++ b/docs/classes/PasskeyError.html @@ -0,0 +1,34 @@ +PasskeyError | @auth0/auth0-angular
                                                                                              @auth0/auth0-angular
                                                                                                Preparing search index...

                                                                                                Class PasskeyError

                                                                                                Hierarchy

                                                                                                • Error
                                                                                                  • PasskeyError
                                                                                                Index

                                                                                                Constructors

                                                                                                constructor +

                                                                                                Properties

                                                                                                cause? +code +message +name +stack? +stackTraceLimit +

                                                                                                Methods

                                                                                                captureStackTrace +prepareStackTrace +

                                                                                                Constructors

                                                                                                Properties

                                                                                                cause?: PasskeyErrorResponse
                                                                                                code: string
                                                                                                message: string
                                                                                                name: string
                                                                                                stack?: string
                                                                                                stackTraceLimit: number

                                                                                                The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                                                                                                +

                                                                                                The default value is 10 but may be set to any valid JavaScript number. Changes +will affect any stack trace captured after the value has been changed.

                                                                                                +

                                                                                                If set to a non-number value, or set to a negative number, stack traces will +not capture any frames.

                                                                                                +

                                                                                                Methods

                                                                                                • Creates a .stack property on targetObject, which when accessed returns +a string representing the location in the code at which +Error.captureStackTrace() was called.

                                                                                                  +
                                                                                                  const myObject = {};
                                                                                                  Error.captureStackTrace(myObject);
                                                                                                  myObject.stack;  // Similar to `new Error().stack`
+
                                                                                                  + +

                                                                                                  The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                  +

                                                                                                  The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                  +

                                                                                                  The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                  +
                                                                                                  function a() {
                                                                                                    b();
                                                                                                  }

                                                                                                  function b() {
                                                                                                    c();
                                                                                                  }

                                                                                                  function c() {
                                                                                                    // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                    const { stackTraceLimit } = Error;
                                                                                                    Error.stackTraceLimit = 0;
                                                                                                    const error = new Error();
                                                                                                    Error.stackTraceLimit = stackTraceLimit;

                                                                                                    // Capture the stack trace above function b
                                                                                                    Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                    throw error;
                                                                                                  }

                                                                                                  a();
+
                                                                                                  + +

                                                                                                  Parameters

                                                                                                  • targetObject: object
                                                                                                  • OptionalconstructorOpt: Function

                                                                                                  Returns void

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Constructors
                                                                                                Properties
                                                                                                Methods
                                                                                                diff --git a/docs/classes/PasskeyGetTokenError.html b/docs/classes/PasskeyGetTokenError.html new file mode 100644 index 00000000..fce2203e --- /dev/null +++ b/docs/classes/PasskeyGetTokenError.html @@ -0,0 +1,37 @@ +PasskeyGetTokenError | @auth0/auth0-angular
                                                                                                @auth0/auth0-angular
                                                                                                  Preparing search index...

                                                                                                  Class PasskeyGetTokenError

                                                                                                  Error thrown when exchanging a passkey credential for tokens fails.

                                                                                                  +

                                                                                                  Unlike the challenge errors, this carries mfa_token / mfa_requirements on +its cause when the server responds with mfa_required.

                                                                                                  +

                                                                                                  Hierarchy

                                                                                                  • PasskeyError
                                                                                                    • PasskeyGetTokenError
                                                                                                  Index

                                                                                                  Constructors

                                                                                                  constructor +

                                                                                                  Properties

                                                                                                  cause? +code +message +name +stack? +stackTraceLimit +

                                                                                                  Methods

                                                                                                  captureStackTrace +prepareStackTrace +

                                                                                                  Constructors

                                                                                                  • Parameters

                                                                                                    • message: string
                                                                                                    • Optionalcause: PasskeyGetTokenApiErrorResponse

                                                                                                    Returns PasskeyGetTokenError

                                                                                                  Properties

                                                                                                  cause?: PasskeyGetTokenApiErrorResponse
                                                                                                  code: string
                                                                                                  message: string
                                                                                                  name: string
                                                                                                  stack?: string
                                                                                                  stackTraceLimit: number

                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                                                                                                  +

                                                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes +will affect any stack trace captured after the value has been changed.

                                                                                                  +

                                                                                                  If set to a non-number value, or set to a negative number, stack traces will +not capture any frames.

                                                                                                  +

                                                                                                  Methods

                                                                                                  • Creates a .stack property on targetObject, which when accessed returns +a string representing the location in the code at which +Error.captureStackTrace() was called.

                                                                                                    +
                                                                                                    const myObject = {};
                                                                                                    Error.captureStackTrace(myObject);
                                                                                                    myObject.stack;  // Similar to `new Error().stack`
+
                                                                                                    + +

                                                                                                    The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                    +

                                                                                                    The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                    +

                                                                                                    The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                    +
                                                                                                    function a() {
                                                                                                      b();
                                                                                                    }

                                                                                                    function b() {
                                                                                                      c();
                                                                                                    }

                                                                                                    function c() {
                                                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                      const { stackTraceLimit } = Error;
                                                                                                      Error.stackTraceLimit = 0;
                                                                                                      const error = new Error();
                                                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                                                      // Capture the stack trace above function b
                                                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                      throw error;
                                                                                                    }

                                                                                                    a();
+
                                                                                                    + +

                                                                                                    Parameters

                                                                                                    • targetObject: object
                                                                                                    • OptionalconstructorOpt: Function

                                                                                                    Returns void

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Constructors
                                                                                                  Properties
                                                                                                  Methods
                                                                                                  diff --git a/docs/classes/PasskeyRegisterError.html b/docs/classes/PasskeyRegisterError.html new file mode 100644 index 00000000..0636686d --- /dev/null +++ b/docs/classes/PasskeyRegisterError.html @@ -0,0 +1,35 @@ +PasskeyRegisterError | @auth0/auth0-angular
                                                                                                  @auth0/auth0-angular
                                                                                                    Preparing search index...

                                                                                                    Class PasskeyRegisterError

                                                                                                    Error thrown when requesting a passkey register challenge fails.

                                                                                                    +

                                                                                                    Hierarchy

                                                                                                    • PasskeyError
                                                                                                      • PasskeyRegisterError
                                                                                                    Index

                                                                                                    Constructors

                                                                                                    constructor +

                                                                                                    Properties

                                                                                                    cause? +code +message +name +stack? +stackTraceLimit +

                                                                                                    Methods

                                                                                                    captureStackTrace +prepareStackTrace +

                                                                                                    Constructors

                                                                                                    • Parameters

                                                                                                      • message: string
                                                                                                      • Optionalcause: PasskeyApiErrorResponse

                                                                                                      Returns PasskeyRegisterError

                                                                                                    Properties

                                                                                                    cause?: PasskeyApiErrorResponse
                                                                                                    code: string
                                                                                                    message: string
                                                                                                    name: string
                                                                                                    stack?: string
                                                                                                    stackTraceLimit: number

                                                                                                    The Error.stackTraceLimit property specifies the number of stack frames +collected by a stack trace (whether generated by new Error().stack or +Error.captureStackTrace(obj)).

                                                                                                    +

                                                                                                    The default value is 10 but may be set to any valid JavaScript number. Changes +will affect any stack trace captured after the value has been changed.

                                                                                                    +

                                                                                                    If set to a non-number value, or set to a negative number, stack traces will +not capture any frames.

                                                                                                    +

                                                                                                    Methods

                                                                                                    • Creates a .stack property on targetObject, which when accessed returns +a string representing the location in the code at which +Error.captureStackTrace() was called.

                                                                                                      +
                                                                                                      const myObject = {};
                                                                                                      Error.captureStackTrace(myObject);
                                                                                                      myObject.stack;  // Similar to `new Error().stack`
+
                                                                                                      + +

                                                                                                      The first line of the trace will be prefixed with +${myObject.name}: ${myObject.message}.

                                                                                                      +

                                                                                                      The optional constructorOpt argument accepts a function. If given, all frames +above constructorOpt, including constructorOpt, will be omitted from the +generated stack trace.

                                                                                                      +

                                                                                                      The constructorOpt argument is useful for hiding implementation +details of error generation from the user. For instance:

                                                                                                      +
                                                                                                      function a() {
                                                                                                        b();
                                                                                                      }

                                                                                                      function b() {
                                                                                                        c();
                                                                                                      }

                                                                                                      function c() {
                                                                                                        // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                        const { stackTraceLimit } = Error;
                                                                                                        Error.stackTraceLimit = 0;
                                                                                                        const error = new Error();
                                                                                                        Error.stackTraceLimit = stackTraceLimit;

                                                                                                        // Capture the stack trace above function b
                                                                                                        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                        throw error;
                                                                                                      }

                                                                                                      a();
+
                                                                                                      + +

                                                                                                      Parameters

                                                                                                      • targetObject: object
                                                                                                      • OptionalconstructorOpt: Function

                                                                                                      Returns void

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Constructors
                                                                                                    Properties
                                                                                                    Methods
                                                                                                    diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index ca611bf2..ccd0c70d 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,1257 +1,37 @@ - - - - - - PopupCancelledError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                    -
                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                      -
                                                                                                      -
                                                                                                      Preparing search index...
                                                                                                      -
                                                                                                      -                                                                                                       - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -

                                                                                                      Class PopupCancelledError

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Thrown when network requests to the Auth server fail.

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      - Hierarchy (View Summary) -

                                                                                                      - -
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -
                                                                                                      Index
                                                                                                      -                                                                                                       -
                                                                                                      -
                                                                                                      -

                                                                                                      Constructors

                                                                                                      -
                                                                                                      - - constructor -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Properties

                                                                                                      -
                                                                                                      - - error - - error_description - - message - - name - - popup - - stack? - - stackTraceLimit -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Methods

                                                                                                      -
                                                                                                      - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -

                                                                                                      Constructors

                                                                                                      -                                                                                                       -
                                                                                                      -
                                                                                                      - - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -

                                                                                                      Properties

                                                                                                      -                                                                                                       -
                                                                                                      -
                                                                                                      - -
                                                                                                      - error: - string -
                                                                                                      - -
                                                                                                      -
                                                                                                      - -
                                                                                                      - error_description: - string -
                                                                                                      - -
                                                                                                      -
                                                                                                      - -
                                                                                                      - message: - string -
                                                                                                      - -
                                                                                                      -
                                                                                                      - -
                                                                                                      - name: - string -
                                                                                                      - -
                                                                                                      -
                                                                                                      - -
                                                                                                      - popup: - Window -
                                                                                                      - -
                                                                                                      -
                                                                                                      - -
                                                                                                      - stack?: - string -
                                                                                                      - -
                                                                                                      -
                                                                                                      - -
                                                                                                      - stackTraceLimit: - number -
                                                                                                      -
                                                                                                      -

                                                                                                      - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                                                      -

                                                                                                      - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                                                      -

                                                                                                      - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -

                                                                                                      Methods

                                                                                                      -                                                                                                       -
                                                                                                      -
                                                                                                      - -
                                                                                                        -
                                                                                                      • - -
                                                                                                        -
                                                                                                        -

                                                                                                        - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                                                        - 
                                                                                                        const myObject = {};
                                                                                                        Error.captureStackTrace(myObject);
                                                                                                        myObject.stack;  // Similar to `new Error().stack`
+PopupCancelledError | @auth0/auth0-angular
                                                                                                        @auth0/auth0-angular
                                                                                                          Preparing search index...
                                                                                                          Class PopupCancelledError
                                                                                                          Thrown when network requests to the Auth server fail.
                                                                                                          
+
                                                                                                          Hierarchy (View Summary)
                                                                                                          Index
                                                                                                          Constructors
                                                                                                          constructor
+
                                                                                                          Properties
                                                                                                          error
+error_description
+message
+name
+popup
+stack?
+stackTraceLimit
+
                                                                                                          Methods
                                                                                                          captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                                          Constructors
                                                                                                          Properties
                                                                                                          error: string
                                                                                                          error_description: string
                                                                                                          message: string
                                                                                                          name: string
                                                                                                          popup: Window
                                                                                                          stack?: string
                                                                                                          stackTraceLimit: number
                                                                                                          The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                                          
+
                                                                                                          The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                                          
+
                                                                                                          If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                                          
+
                                                                                                          Methods
                                                                                                          • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                                            
+
                                                                                                            const myObject = {};
                                                                                                            Error.captureStackTrace(myObject);
                                                                                                            myObject.stack;  // Similar to `new Error().stack`
 
                                                                                                            
 
-                      
                                                                                                            
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                                            
-                      
                                                                                                            
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                                            
-                      
                                                                                                            
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                                            
-                      
                                                                                                            function a() {
                                                                                                              b();
                                                                                                            }

                                                                                                            function b() {
                                                                                                              c();
                                                                                                            }

                                                                                                            function c() {
                                                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                              const { stackTraceLimit } = Error;
                                                                                                              Error.stackTraceLimit = 0;
                                                                                                              const error = new Error();
                                                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                                                              // Capture the stack trace above function b
                                                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                              throw error;
                                                                                                            }

                                                                                                            a();
+
                                                                                                            The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                                            
+
                                                                                                            The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                                            
+
                                                                                                            The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                                            
+
                                                                                                            function a() {
                                                                                                              b();
                                                                                                            }

                                                                                                            function b() {
                                                                                                              c();
                                                                                                            }

                                                                                                            function c() {
                                                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                              const { stackTraceLimit } = Error;
                                                                                                              Error.stackTraceLimit = 0;
                                                                                                              const error = new Error();
                                                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                                                              // Capture the stack trace above function b
                                                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                              throw error;
                                                                                                            }

                                                                                                            a();
 
                                                                                                            
-                    
                                                                                                            
-                    
                                                                                                            
-                      
                                                                                                            Parameters
                                                                                                            
-                      
                                                                                                              
-                        
                                                                                                            • 
-                          targetObject:
-                            object
-                        
                                                                                                              • 
-                        
                                                                                                            • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                                              • 
-                      
                                                                                                            
-                    
                                                                                                            
-                    
                                                                                                            
-                      Returns void
-                    
                                                                                                            
-                    
-                  
                                                                                                            
-                
                                                                                                            • 
-              
                                                                                                          
-            
                                                                                                          
-            
                                                                                                          
-              
-              
                                                                                                            
-                
                                                                                                          • 
-                  
-                  
                                                                                                            
-                    
                                                                                                            
-                      
                                                                                                            Parameters
                                                                                                            
-                      
                                                                                                              
-                        
                                                                                                            • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                                              • 
-                      
                                                                                                            
-                    
                                                                                                            
-                    
                                                                                                            
-                      Returns
-                      GenericError
-                    
                                                                                                            
-                    
-                  
                                                                                                            
-                
                                                                                                            • 
-              
                                                                                                          
-            
                                                                                                          
-            
                                                                                                          
-              
-              
-            
                                                                                                          
-          
                                                                                                          
-        
                                                                                                          
-      
                                                                                                          
-      
                                                                                                          
-        
                                                                                                          
-          
                                                                                                          
-            
                                                                                                          
-              
-                
-                
                                                                                                          Settings
                                                                                                          
-                                                                                                                        
-              
                                                                                                          
-                
                                                                                                          
-                  Member Visibility
-                  
                                                                                                            
-                    
                                                                                                          • 
-                      
-                    
                                                                                                            • 
-                    
                                                                                                          • 
-                      
-                    
                                                                                                            • 
-                    
                                                                                                          • 
-                      
-                    
                                                                                                            • 
-                  
                                                                                                          
-                
                                                                                                          
-                
                                                                                                          
-                  
-                
                                                                                                          
-              
                                                                                                          
-            
                                                                                                          
-          
                                                                                                          
-          
                                                                                                          
-            
-              
-              
                                                                                                          On This Page
                                                                                                          
-                                                                                                                      
-            
                                                                                                          
-              
                                                                                                          
-                
-                  Constructors
-                
-                
-              
                                                                                                          
-              
                                                                                                          
-                
-                  Properties
-                
-                
-              
                                                                                                          
-              
                                                                                                          
-                
-                  Methods
-                
-                
-              
                                                                                                          
-            
                                                                                                          
-          
                                                                                                          
-        
                                                                                                          
-        
                                                                                                          
-          
-        
                                                                                                          
-      
                                                                                                          
-    
                                                                                                          
-    
                                                                                                          
-    
                                                                                                          
-  
-
+
+

                                                                                                          Parameters

                                                                                                          • targetObject: object
                                                                                                          • OptionalconstructorOpt: Function

                                                                                                          Returns void

                                                                                                        • Parameters

                                                                                                          • __namedParameters: { error: string; error_description: string }

                                                                                                          Returns GenericError

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Constructors
                                                                                                        Properties
                                                                                                        Methods
                                                                                                        diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index 8fb87b67..5ae5d4fa 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -1,1203 +1,36 @@ - - - - - - PopupOpenError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                        -
                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                          -
                                                                                                          -
                                                                                                          Preparing search index...
                                                                                                          -
                                                                                                          -                                                                                                           - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          Class PopupOpenError

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Thrown when network requests to the Auth server fail.

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          - Hierarchy (View Summary) -

                                                                                                          - -
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          - - -
                                                                                                          Index
                                                                                                          -                                                                                                           -
                                                                                                          -
                                                                                                          -

                                                                                                          Constructors

                                                                                                          -
                                                                                                          - - constructor -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Properties

                                                                                                          -
                                                                                                          - - error - - error_description - - message - - name - - stack? - - stackTraceLimit -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Methods

                                                                                                          -
                                                                                                          - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - - -

                                                                                                          Constructors

                                                                                                          -                                                                                                           -
                                                                                                          -
                                                                                                          - - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - - -

                                                                                                          Properties

                                                                                                          -                                                                                                           -
                                                                                                          -
                                                                                                          - -
                                                                                                          - error: - string -
                                                                                                          - -
                                                                                                          -
                                                                                                          - -
                                                                                                          - error_description: - string -
                                                                                                          - -
                                                                                                          -
                                                                                                          - -
                                                                                                          - message: - string -
                                                                                                          - -
                                                                                                          -
                                                                                                          - -
                                                                                                          - name: - string -
                                                                                                          - -
                                                                                                          -
                                                                                                          - -
                                                                                                          - stack?: - string -
                                                                                                          - -
                                                                                                          -
                                                                                                          - -
                                                                                                          - stackTraceLimit: - number -
                                                                                                          -
                                                                                                          -

                                                                                                          - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                                                          -

                                                                                                          - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                                                          -

                                                                                                          - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                                                          -
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - - -

                                                                                                          Methods

                                                                                                          -                                                                                                           -
                                                                                                          -
                                                                                                          - -
                                                                                                            -
                                                                                                          • - -
                                                                                                            -
                                                                                                            -

                                                                                                            - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                                                            - 
                                                                                                            const myObject = {};
                                                                                                            Error.captureStackTrace(myObject);
                                                                                                            myObject.stack;  // Similar to `new Error().stack`
+PopupOpenError | @auth0/auth0-angular
                                                                                                            @auth0/auth0-angular
                                                                                                              Preparing search index...
                                                                                                              Class PopupOpenError
                                                                                                              Thrown when network requests to the Auth server fail.
                                                                                                              
+
                                                                                                              Hierarchy (View Summary)
                                                                                                              Index
                                                                                                              Constructors
                                                                                                              constructor
+
                                                                                                              Properties
                                                                                                              error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                                                                              Methods
                                                                                                              captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                                              Constructors
                                                                                                              Properties
                                                                                                              error: string
                                                                                                              error_description: string
                                                                                                              message: string
                                                                                                              name: string
                                                                                                              stack?: string
                                                                                                              stackTraceLimit: number
                                                                                                              The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                                              
+
                                                                                                              The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                                              
+
                                                                                                              If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                                              
+
                                                                                                              Methods
                                                                                                              • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                                                
+
                                                                                                                const myObject = {};
                                                                                                                Error.captureStackTrace(myObject);
                                                                                                                myObject.stack;  // Similar to `new Error().stack`
 
                                                                                                                
 
-                      
                                                                                                                
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                                                
-                      
                                                                                                                
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                                                
-                      
                                                                                                                
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                                                
-                      
                                                                                                                function a() {
                                                                                                                  b();
                                                                                                                }

                                                                                                                function b() {
                                                                                                                  c();
                                                                                                                }

                                                                                                                function c() {
                                                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                  const { stackTraceLimit } = Error;
                                                                                                                  Error.stackTraceLimit = 0;
                                                                                                                  const error = new Error();
                                                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                                                  // Capture the stack trace above function b
                                                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                  throw error;
                                                                                                                }

                                                                                                                a();
+
                                                                                                                The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                                                
+
                                                                                                                The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                                                
+
                                                                                                                The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                                                
+
                                                                                                                function a() {
                                                                                                                  b();
                                                                                                                }

                                                                                                                function b() {
                                                                                                                  c();
                                                                                                                }

                                                                                                                function c() {
                                                                                                                  // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                  const { stackTraceLimit } = Error;
                                                                                                                  Error.stackTraceLimit = 0;
                                                                                                                  const error = new Error();
                                                                                                                  Error.stackTraceLimit = stackTraceLimit;

                                                                                                                  // Capture the stack trace above function b
                                                                                                                  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                  throw error;
                                                                                                                }

                                                                                                                a();
 
                                                                                                                
-                    
                                                                                                                
-                    
                                                                                                                
-                      
                                                                                                                Parameters
                                                                                                                
-                      
                                                                                                                  
-                        
                                                                                                                • 
-                          targetObject:
-                            object
-                        
                                                                                                                  • 
-                        
                                                                                                                • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                                                  • 
-                      
                                                                                                                
-                    
                                                                                                                
-                    
                                                                                                                
-                      Returns void
-                    
                                                                                                                
-                    
-                  
                                                                                                                
-                
                                                                                                                • 
-              
                                                                                                              
-            
                                                                                                              
-            
                                                                                                              
-              
-              
                                                                                                                
-                
                                                                                                              • 
-                  
-                  
                                                                                                                
-                    
                                                                                                                
-                      
                                                                                                                Parameters
                                                                                                                
-                      
                                                                                                                  
-                        
                                                                                                                • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                                                  • 
-                      
                                                                                                                
-                    
                                                                                                                
-                    
                                                                                                                
-                      Returns
-                      GenericError
-                    
                                                                                                                
-                    
-                  
                                                                                                                
-                
                                                                                                                • 
-              
                                                                                                              
-            
                                                                                                              
-            
                                                                                                              
-              
-              
-            
                                                                                                              
-          
                                                                                                              
-        
                                                                                                              
-      
                                                                                                              
-      
                                                                                                              
-        
                                                                                                              
-          
                                                                                                              
-            
                                                                                                              
-              
-                
-                
                                                                                                              Settings
                                                                                                              
-                                                                                                                            
-              
                                                                                                              
-                
                                                                                                              
-                  Member Visibility
-                  
                                                                                                                
-                    
                                                                                                              • 
-                      
-                    
                                                                                                                • 
-                    
                                                                                                              • 
-                      
-                    
                                                                                                                • 
-                    
                                                                                                              • 
-                      
-                    
                                                                                                                • 
-                  
                                                                                                              
-                
                                                                                                              
-                
                                                                                                              
-                  
-                
                                                                                                              
-              
                                                                                                              
-            
                                                                                                              
-          
                                                                                                              
-          
                                                                                                              
-            
-              
-              
                                                                                                              On This Page
                                                                                                              
-                                                                                                                          
-            
                                                                                                              
-              
                                                                                                              
-                
-                  Constructors
-                
-                
-              
                                                                                                              
-              
                                                                                                              
-                
-                  Properties
-                
-                
-              
                                                                                                              
-              
                                                                                                              
-                
-                  Methods
-                
-                
-              
                                                                                                              
-            
                                                                                                              
-          
                                                                                                              
-        
                                                                                                              
-        
                                                                                                              
-          
-        
                                                                                                              
-      
                                                                                                              
-    
                                                                                                              
-    
                                                                                                              
-    
                                                                                                              
-  
-
+
+

                                                                                                              Parameters

                                                                                                              • targetObject: object
                                                                                                              • OptionalconstructorOpt: Function

                                                                                                              Returns void

                                                                                                            • Parameters

                                                                                                              • __namedParameters: { error: string; error_description: string }

                                                                                                              Returns GenericError

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Constructors
                                                                                                            Properties
                                                                                                            Methods
                                                                                                            diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index 9a271257..4bbf2566 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,1260 +1,37 @@ - - - - - - PopupTimeoutError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                            -
                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                              -
                                                                                                              -
                                                                                                              Preparing search index...
                                                                                                              -
                                                                                                              -                                                                                                               - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - -

                                                                                                              Class PopupTimeoutError

                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              - Error thrown when the login popup times out (if the user does not - complete auth) -

                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              - Hierarchy (View Summary) -

                                                                                                              - -
                                                                                                              - -
                                                                                                              -
                                                                                                              -
                                                                                                              - - -
                                                                                                              Index
                                                                                                              -                                                                                                               -
                                                                                                              -
                                                                                                              -

                                                                                                              Constructors

                                                                                                              -
                                                                                                              - - constructor -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              Properties

                                                                                                              -
                                                                                                              - - error - - error_description - - message - - name - - popup - - stack? - - stackTraceLimit -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              Methods

                                                                                                              -
                                                                                                              - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - - -

                                                                                                              Constructors

                                                                                                              -                                                                                                               -
                                                                                                              -
                                                                                                              - - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - - -

                                                                                                              Properties

                                                                                                              -                                                                                                               -
                                                                                                              -
                                                                                                              - -
                                                                                                              - error: - string -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - error_description: - string -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - message: - string -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - name: - string -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - popup: - Window -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - stack?: - string -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - stackTraceLimit: - number -
                                                                                                              -
                                                                                                              -

                                                                                                              - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                                                              -

                                                                                                              - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                                                              -

                                                                                                              - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - - -

                                                                                                              Methods

                                                                                                              -                                                                                                               -
                                                                                                              -
                                                                                                              - -
                                                                                                                -
                                                                                                              • - -
                                                                                                                -
                                                                                                                -

                                                                                                                - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                                                                - 
                                                                                                                const myObject = {};
                                                                                                                Error.captureStackTrace(myObject);
                                                                                                                myObject.stack;  // Similar to `new Error().stack`
+PopupTimeoutError | @auth0/auth0-angular
                                                                                                                @auth0/auth0-angular
                                                                                                                  Preparing search index...
                                                                                                                  Class PopupTimeoutError
                                                                                                                  Error thrown when the login popup times out (if the user does not complete auth)
                                                                                                                  
+
                                                                                                                  Hierarchy (View Summary)
                                                                                                                  Index
                                                                                                                  Constructors
                                                                                                                  constructor
+
                                                                                                                  Properties
                                                                                                                  error
+error_description
+message
+name
+popup
+stack?
+stackTraceLimit
+
                                                                                                                  Methods
                                                                                                                  captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                                                  Constructors
                                                                                                                  Properties
                                                                                                                  error: string
                                                                                                                  error_description: string
                                                                                                                  message: string
                                                                                                                  name: string
                                                                                                                  popup: Window
                                                                                                                  stack?: string
                                                                                                                  stackTraceLimit: number
                                                                                                                  The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                                                  
+
                                                                                                                  The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                                                  
+
                                                                                                                  If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                                                  
+
                                                                                                                  Methods
                                                                                                                  • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                                                    
+
                                                                                                                    const myObject = {};
                                                                                                                    Error.captureStackTrace(myObject);
                                                                                                                    myObject.stack;  // Similar to `new Error().stack`
 
                                                                                                                    
 
-                      
                                                                                                                    
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                                                    
-                      
                                                                                                                    
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                                                    
-                      
                                                                                                                    
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                                                    
-                      
                                                                                                                    function a() {
                                                                                                                      b();
                                                                                                                    }

                                                                                                                    function b() {
                                                                                                                      c();
                                                                                                                    }

                                                                                                                    function c() {
                                                                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                      const { stackTraceLimit } = Error;
                                                                                                                      Error.stackTraceLimit = 0;
                                                                                                                      const error = new Error();
                                                                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                                                                      // Capture the stack trace above function b
                                                                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                      throw error;
                                                                                                                    }

                                                                                                                    a();
+
                                                                                                                    The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                                                    
+
                                                                                                                    The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                                                    
+
                                                                                                                    The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                                                    
+
                                                                                                                    function a() {
                                                                                                                      b();
                                                                                                                    }

                                                                                                                    function b() {
                                                                                                                      c();
                                                                                                                    }

                                                                                                                    function c() {
                                                                                                                      // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                      const { stackTraceLimit } = Error;
                                                                                                                      Error.stackTraceLimit = 0;
                                                                                                                      const error = new Error();
                                                                                                                      Error.stackTraceLimit = stackTraceLimit;

                                                                                                                      // Capture the stack trace above function b
                                                                                                                      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                      throw error;
                                                                                                                    }

                                                                                                                    a();
 
                                                                                                                    
-                    
                                                                                                                    
-                    
                                                                                                                    
-                      
                                                                                                                    Parameters
                                                                                                                    
-                      
                                                                                                                      
-                        
                                                                                                                    • 
-                          targetObject:
-                            object
-                        
                                                                                                                      • 
-                        
                                                                                                                    • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                                                      • 
-                      
                                                                                                                    
-                    
                                                                                                                    
-                    
                                                                                                                    
-                      Returns void
-                    
                                                                                                                    
-                    
-                  
                                                                                                                    
-                
                                                                                                                    • 
-              
                                                                                                                  
-            
                                                                                                                  
-            
                                                                                                                  
-              
-              
                                                                                                                    
-                
                                                                                                                  • 
-                  
-                  
                                                                                                                    
-                    
                                                                                                                    
-                      
                                                                                                                    Parameters
                                                                                                                    
-                      
                                                                                                                      
-                        
                                                                                                                    • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                                                      • 
-                      
                                                                                                                    
-                    
                                                                                                                    
-                    
                                                                                                                    
-                      Returns
-                      GenericError
-                    
                                                                                                                    
-                    
-                  
                                                                                                                    
-                
                                                                                                                    • 
-              
                                                                                                                  
-            
                                                                                                                  
-            
                                                                                                                  
-              
-              
-            
                                                                                                                  
-          
                                                                                                                  
-        
                                                                                                                  
-      
                                                                                                                  
-      
                                                                                                                  
-        
                                                                                                                  
-          
                                                                                                                  
-            
                                                                                                                  
-              
-                
-                
                                                                                                                  Settings
                                                                                                                  
-                                                                                                                                
-              
                                                                                                                  
-                
                                                                                                                  
-                  Member Visibility
-                  
                                                                                                                    
-                    
                                                                                                                  • 
-                      
-                    
                                                                                                                    • 
-                    
                                                                                                                  • 
-                      
-                    
                                                                                                                    • 
-                    
                                                                                                                  • 
-                      
-                    
                                                                                                                    • 
-                  
                                                                                                                  
-                
                                                                                                                  
-                
                                                                                                                  
-                  
-                
                                                                                                                  
-              
                                                                                                                  
-            
                                                                                                                  
-          
                                                                                                                  
-          
                                                                                                                  
-            
-              
-              
                                                                                                                  On This Page
                                                                                                                  
-                                                                                                                              
-            
                                                                                                                  
-              
                                                                                                                  
-                
-                  Constructors
-                
-                
-              
                                                                                                                  
-              
                                                                                                                  
-                
-                  Properties
-                
-                
-              
                                                                                                                  
-              
                                                                                                                  
-                
-                  Methods
-                
-                
-              
                                                                                                                  
-            
                                                                                                                  
-          
                                                                                                                  
-        
                                                                                                                  
-        
                                                                                                                  
-          
-        
                                                                                                                  
-      
                                                                                                                  
-    
                                                                                                                  
-    
                                                                                                                  
-    
                                                                                                                  
-  
-
+
+

                                                                                                                  Parameters

                                                                                                                  • targetObject: object
                                                                                                                  • OptionalconstructorOpt: Function

                                                                                                                  Returns void

                                                                                                                • Parameters

                                                                                                                  • __namedParameters: { error: string; error_description: string }

                                                                                                                  Returns GenericError

                                                                                                                Settings

                                                                                                                Member Visibility

                                                                                                                On This Page

                                                                                                                Constructors
                                                                                                                Properties
                                                                                                                Methods
                                                                                                                diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index 5b67e68f..21285bb7 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,1214 +1,37 @@ - - - - - - TimeoutError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                -
                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  Preparing search index...
                                                                                                                  -
                                                                                                                  -                                                                                                                   - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -

                                                                                                                  Class TimeoutError

                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  - Thrown when silent auth times out (usually due to a configuration - issue) or when network requests to the Auth server timeout. -

                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  - Hierarchy (View Summary) -

                                                                                                                  - -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  Index
                                                                                                                  -                                                                                                                   -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Constructors

                                                                                                                  -
                                                                                                                  - - constructor -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Properties

                                                                                                                  -
                                                                                                                  - - error - - error_description - - message - - name - - stack? - - stackTraceLimit -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Methods

                                                                                                                  -
                                                                                                                  - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - -

                                                                                                                  Constructors

                                                                                                                  -                                                                                                                   -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - -

                                                                                                                  Properties

                                                                                                                  -                                                                                                                   -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - error: - string -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - error_description: - string -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - message: - string -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - name: - string -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - stack?: - string -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - stackTraceLimit: - number -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                                                                  -

                                                                                                                  - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                                                                  -

                                                                                                                  - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - -

                                                                                                                  Methods

                                                                                                                  -                                                                                                                   -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                    -
                                                                                                                  • - -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                                                                    - 
                                                                                                                    const myObject = {};
                                                                                                                    Error.captureStackTrace(myObject);
                                                                                                                    myObject.stack;  // Similar to `new Error().stack`
+TimeoutError | @auth0/auth0-angular
                                                                                                                    @auth0/auth0-angular
                                                                                                                      Preparing search index...
                                                                                                                      Class TimeoutError
                                                                                                                      Thrown when silent auth times out (usually due to a configuration issue) or
+when network requests to the Auth server timeout.
                                                                                                                      
+
                                                                                                                      Hierarchy (View Summary)
                                                                                                                      Index
                                                                                                                      Constructors
                                                                                                                      constructor
+
                                                                                                                      Properties
                                                                                                                      error
+error_description
+message
+name
+stack?
+stackTraceLimit
+
                                                                                                                      Methods
                                                                                                                      captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                                                      Constructors
                                                                                                                      Properties
                                                                                                                      error: string
                                                                                                                      error_description: string
                                                                                                                      message: string
                                                                                                                      name: string
                                                                                                                      stack?: string
                                                                                                                      stackTraceLimit: number
                                                                                                                      The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                                                      
+
                                                                                                                      The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                                                      
+
                                                                                                                      If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                                                      
+
                                                                                                                      Methods
                                                                                                                      • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                                                        
+
                                                                                                                        const myObject = {};
                                                                                                                        Error.captureStackTrace(myObject);
                                                                                                                        myObject.stack;  // Similar to `new Error().stack`
 
                                                                                                                        
 
-                      
                                                                                                                        
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                                                        
-                      
                                                                                                                        
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                                                        
-                      
                                                                                                                        
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                                                        
-                      
                                                                                                                        function a() {
                                                                                                                          b();
                                                                                                                        }

                                                                                                                        function b() {
                                                                                                                          c();
                                                                                                                        }

                                                                                                                        function c() {
                                                                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                          const { stackTraceLimit } = Error;
                                                                                                                          Error.stackTraceLimit = 0;
                                                                                                                          const error = new Error();
                                                                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                                                                          // Capture the stack trace above function b
                                                                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                          throw error;
                                                                                                                        }

                                                                                                                        a();
+
                                                                                                                        The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                                                        
+
                                                                                                                        The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                                                        
+
                                                                                                                        The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                                                        
+
                                                                                                                        function a() {
                                                                                                                          b();
                                                                                                                        }

                                                                                                                        function b() {
                                                                                                                          c();
                                                                                                                        }

                                                                                                                        function c() {
                                                                                                                          // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                          const { stackTraceLimit } = Error;
                                                                                                                          Error.stackTraceLimit = 0;
                                                                                                                          const error = new Error();
                                                                                                                          Error.stackTraceLimit = stackTraceLimit;

                                                                                                                          // Capture the stack trace above function b
                                                                                                                          Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                          throw error;
                                                                                                                        }

                                                                                                                        a();
 
                                                                                                                        
-                    
                                                                                                                        
-                    
                                                                                                                        
-                      
                                                                                                                        Parameters
                                                                                                                        
-                      
                                                                                                                          
-                        
                                                                                                                        • 
-                          targetObject:
-                            object
-                        
                                                                                                                          • 
-                        
                                                                                                                        • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                                                          • 
-                      
                                                                                                                        
-                    
                                                                                                                        
-                    
                                                                                                                        
-                      Returns void
-                    
                                                                                                                        
-                    
-                  
                                                                                                                        
-                
                                                                                                                        • 
-              
                                                                                                                      
-            
                                                                                                                      
-            
                                                                                                                      
-              
-              
                                                                                                                        
-                
                                                                                                                      • 
-                  
-                  
                                                                                                                        
-                    
                                                                                                                        
-                      
                                                                                                                        Parameters
                                                                                                                        
-                      
                                                                                                                          
-                        
                                                                                                                        • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                                                          • 
-                      
                                                                                                                        
-                    
                                                                                                                        
-                    
                                                                                                                        
-                      Returns
-                      GenericError
-                    
                                                                                                                        
-                    
-                  
                                                                                                                        
-                
                                                                                                                        • 
-              
                                                                                                                      
-            
                                                                                                                      
-            
                                                                                                                      
-              
-              
-            
                                                                                                                      
-          
                                                                                                                      
-        
                                                                                                                      
-      
                                                                                                                      
-      
                                                                                                                      
-        
                                                                                                                      
-          
                                                                                                                      
-            
                                                                                                                      
-              
-                
-                
                                                                                                                      Settings
                                                                                                                      
-                                                                                                                                    
-              
                                                                                                                      
-                
                                                                                                                      
-                  Member Visibility
-                  
                                                                                                                        
-                    
                                                                                                                      • 
-                      
-                    
                                                                                                                        • 
-                    
                                                                                                                      • 
-                      
-                    
                                                                                                                        • 
-                    
                                                                                                                      • 
-                      
-                    
                                                                                                                        • 
-                  
                                                                                                                      
-                
                                                                                                                      
-                
                                                                                                                      
-                  
-                
                                                                                                                      
-              
                                                                                                                      
-            
                                                                                                                      
-          
                                                                                                                      
-          
                                                                                                                      
-            
-              
-              
                                                                                                                      On This Page
                                                                                                                      
-                                                                                                                                  
-            
                                                                                                                      
-              
                                                                                                                      
-                
-                  Constructors
-                
-                
-              
                                                                                                                      
-              
                                                                                                                      
-                
-                  Properties
-                
-                
-              
                                                                                                                      
-              
                                                                                                                      
-                
-                  Methods
-                
-                
-              
                                                                                                                      
-            
                                                                                                                      
-          
                                                                                                                      
-        
                                                                                                                      
-        
                                                                                                                      
-          
-        
                                                                                                                      
-      
                                                                                                                      
-    
                                                                                                                      
-    
                                                                                                                      
-    
                                                                                                                      
-  
-
+
+

                                                                                                                      Parameters

                                                                                                                      • targetObject: object
                                                                                                                      • OptionalconstructorOpt: Function

                                                                                                                      Returns void

                                                                                                                    • Parameters

                                                                                                                      • __namedParameters: { error: string; error_description: string }

                                                                                                                      Returns GenericError

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    On This Page

                                                                                                                    Constructors
                                                                                                                    Properties
                                                                                                                    Methods
                                                                                                                    diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index c098c5da..7aca6d4b 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,1273 +1,37 @@ - - - - - - UseDpopNonceError | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      Preparing search index...
                                                                                                                      -
                                                                                                                      -                                                                                                                       - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -

                                                                                                                      Class UseDpopNonceError

                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      - Error thrown when the wrong DPoP nonce is used and a potential - subsequent retry wasn't able to fix it. -

                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      - Hierarchy (View Summary) -

                                                                                                                      - -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      Index
                                                                                                                      -                                                                                                                       -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Constructors

                                                                                                                      -
                                                                                                                      - - constructor -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Properties

                                                                                                                      -
                                                                                                                      - - error - - error_description - - message - - name - - newDpopNonce - - stack? - - stackTraceLimit -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Methods

                                                                                                                      -
                                                                                                                      - - captureStackTrace - - fromPayload - - prepareStackTrace -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - - -

                                                                                                                      Constructors

                                                                                                                      -                                                                                                                       -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                        -
                                                                                                                      • - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        Parameters

                                                                                                                        -
                                                                                                                          -
                                                                                                                        • - newDpopNonce: string - | - undefined -
                                                                                                                          • -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - Returns - UseDpopNonceError -

                                                                                                                        - -
                                                                                                                        -
                                                                                                                        • -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - - -

                                                                                                                      Properties

                                                                                                                      -                                                                                                                       -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - error: - string -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - error_description: - string -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - message: - string -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - name: - string -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - newDpopNonce: - string - | - undefined -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - stack?: - string -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - stackTraceLimit: - number -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      - The Error.stackTraceLimit property specifies the - number of stack frames collected by a stack trace (whether - generated by new Error().stack or - Error.captureStackTrace(obj)). -

                                                                                                                      -

                                                                                                                      - The default value is 10 but may be set to any - valid JavaScript number. Changes will affect any stack trace - captured after the value has been changed. -

                                                                                                                      -

                                                                                                                      - If set to a non-number value, or set to a negative number, - stack traces will not capture any frames. -

                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - - -

                                                                                                                      Methods

                                                                                                                      -                                                                                                                       -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                        -
                                                                                                                      • - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - Creates a .stack property on - targetObject, which when accessed returns a - string representing the location in the code at which - Error.captureStackTrace() was called. -

                                                                                                                        - 
                                                                                                                        const myObject = {};
                                                                                                                        Error.captureStackTrace(myObject);
                                                                                                                        myObject.stack;  // Similar to `new Error().stack`
+UseDpopNonceError | @auth0/auth0-angular
                                                                                                                        @auth0/auth0-angular
                                                                                                                          Preparing search index...
                                                                                                                          Class UseDpopNonceError
                                                                                                                          Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.
                                                                                                                          
+
                                                                                                                          Hierarchy (View Summary)
                                                                                                                          Index
                                                                                                                          Constructors
                                                                                                                          constructor
+
                                                                                                                          Properties
                                                                                                                          error
+error_description
+message
+name
+newDpopNonce
+stack?
+stackTraceLimit
+
                                                                                                                          Methods
                                                                                                                          captureStackTrace
+fromPayload
+prepareStackTrace
+
                                                                                                                          Constructors
                                                                                                                          Properties
                                                                                                                          error: string
                                                                                                                          error_description: string
                                                                                                                          message: string
                                                                                                                          name: string
                                                                                                                          newDpopNonce: string | undefined
                                                                                                                          stack?: string
                                                                                                                          stackTraceLimit: number
                                                                                                                          The Error.stackTraceLimit property specifies the number of stack frames
+collected by a stack trace (whether generated by new Error().stack or
+Error.captureStackTrace(obj)).
                                                                                                                          
+
                                                                                                                          The default value is 10 but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured after the value has been changed.
                                                                                                                          
+
                                                                                                                          If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
                                                                                                                          
+
                                                                                                                          Methods
                                                                                                                          • Creates a .stack property on targetObject, which when accessed returns
+a string representing the location in the code at which
+Error.captureStackTrace() was called.
                                                                                                                            
+
                                                                                                                            const myObject = {};
                                                                                                                            Error.captureStackTrace(myObject);
                                                                                                                            myObject.stack;  // Similar to `new Error().stack`
 
                                                                                                                            
 
-                      
                                                                                                                            
-                        The first line of the trace will be prefixed with
-                        ${myObject.name}: ${myObject.message}.
-                      
                                                                                                                            
-                      
                                                                                                                            
-                        The optional constructorOpt argument
-                        accepts a function. If given, all frames above
-                        constructorOpt, including
-                        constructorOpt, will be omitted from the
-                        generated stack trace.
-                      
                                                                                                                            
-                      
                                                                                                                            
-                        The constructorOpt argument is useful for
-                        hiding implementation details of error generation from
-                        the user. For instance:
-                      
                                                                                                                            
-                      
                                                                                                                            function a() {
                                                                                                                              b();
                                                                                                                            }

                                                                                                                            function b() {
                                                                                                                              c();
                                                                                                                            }

                                                                                                                            function c() {
                                                                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                              const { stackTraceLimit } = Error;
                                                                                                                              Error.stackTraceLimit = 0;
                                                                                                                              const error = new Error();
                                                                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                                                                              // Capture the stack trace above function b
                                                                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                              throw error;
                                                                                                                            }

                                                                                                                            a();
+
                                                                                                                            The first line of the trace will be prefixed with
+${myObject.name}: ${myObject.message}.
                                                                                                                            
+
                                                                                                                            The optional constructorOpt argument accepts a function. If given, all frames
+above constructorOpt, including constructorOpt, will be omitted from the
+generated stack trace.
                                                                                                                            
+
                                                                                                                            The constructorOpt argument is useful for hiding implementation
+details of error generation from the user. For instance:
                                                                                                                            
+
                                                                                                                            function a() {
                                                                                                                              b();
                                                                                                                            }

                                                                                                                            function b() {
                                                                                                                              c();
                                                                                                                            }

                                                                                                                            function c() {
                                                                                                                              // Create an error without stack trace to avoid calculating the stack trace twice.
                                                                                                                              const { stackTraceLimit } = Error;
                                                                                                                              Error.stackTraceLimit = 0;
                                                                                                                              const error = new Error();
                                                                                                                              Error.stackTraceLimit = stackTraceLimit;

                                                                                                                              // Capture the stack trace above function b
                                                                                                                              Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
                                                                                                                              throw error;
                                                                                                                            }

                                                                                                                            a();
 
                                                                                                                            
-                    
                                                                                                                            
-                    
                                                                                                                            
-                      
                                                                                                                            Parameters
                                                                                                                            
-                      
                                                                                                                              
-                        
                                                                                                                            • 
-                          targetObject:
-                            object
-                        
                                                                                                                              • 
-                        
                                                                                                                            • 
-                          OptionalconstructorOpt:
-                            Function
-                        
                                                                                                                              • 
-                      
                                                                                                                            
-                    
                                                                                                                            
-                    
                                                                                                                            
-                      Returns void
-                    
                                                                                                                            
-                    
-                  
                                                                                                                            
-                
                                                                                                                            • 
-              
                                                                                                                          
-            
                                                                                                                          
-            
                                                                                                                          
-              
-              
                                                                                                                            
-                
                                                                                                                          • 
-                  
-                  
                                                                                                                            
-                    
                                                                                                                            
-                      
                                                                                                                            Parameters
                                                                                                                            
-                      
                                                                                                                              
-                        
                                                                                                                            • 
-                          __namedParameters: {
-                            error:
-                            string;
-                            error_description:
-                            string
-                            }
-                        
                                                                                                                              • 
-                      
                                                                                                                            
-                    
                                                                                                                            
-                    
                                                                                                                            
-                      Returns
-                      GenericError
-                    
                                                                                                                            
-                    
-                  
                                                                                                                            
-                
                                                                                                                            • 
-              
                                                                                                                          
-            
                                                                                                                          
-            
                                                                                                                          
-              
-              
-            
                                                                                                                          
-          
                                                                                                                          
-        
                                                                                                                          
-      
                                                                                                                          
-      
                                                                                                                          
-        
                                                                                                                          
-          
                                                                                                                          
-            
                                                                                                                          
-              
-                
-                
                                                                                                                          Settings
                                                                                                                          
-                                                                                                                                        
-              
                                                                                                                          
-                
                                                                                                                          
-                  Member Visibility
-                  
                                                                                                                            
-                    
                                                                                                                          • 
-                      
-                    
                                                                                                                            • 
-                    
                                                                                                                          • 
-                      
-                    
                                                                                                                            • 
-                    
                                                                                                                          • 
-                      
-                    
                                                                                                                            • 
-                  
                                                                                                                          
-                
                                                                                                                          
-                
                                                                                                                          
-                  
-                
                                                                                                                          
-              
                                                                                                                          
-            
                                                                                                                          
-          
                                                                                                                          
-          
                                                                                                                          
-            
-              
-              
                                                                                                                          On This Page
                                                                                                                          
-                                                                                                                                      
-            
                                                                                                                          
-              
                                                                                                                          
-                
-                  Constructors
-                
-                
-              
                                                                                                                          
-              
                                                                                                                          
-                
-                  Properties
-                
-                
-              
                                                                                                                          
-              
                                                                                                                          
-                
-                  Methods
-                
-                
-              
                                                                                                                          
-            
                                                                                                                          
-          
                                                                                                                          
-        
                                                                                                                          
-        
                                                                                                                          
-          
-        
                                                                                                                          
-      
                                                                                                                          
-    
                                                                                                                          
-    
                                                                                                                          
-    
                                                                                                                          
-  
-
+
+

                                                                                                                          Parameters

                                                                                                                          • targetObject: object
                                                                                                                          • OptionalconstructorOpt: Function

                                                                                                                          Returns void

                                                                                                                        • Parameters

                                                                                                                          • __namedParameters: { error: string; error_description: string }

                                                                                                                          Returns GenericError

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        On This Page

                                                                                                                        Constructors
                                                                                                                        Properties
                                                                                                                        Methods
                                                                                                                        diff --git a/docs/classes/User.html b/docs/classes/User.html index 499ffa4c..86d6c260 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,1289 +1,23 @@ - - - - - - User | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          Preparing search index...
                                                                                                                          -
                                                                                                                          -                                                                                                                           - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Class User

                                                                                                                          -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          Indexable

                                                                                                                          -
                                                                                                                            -
                                                                                                                          • -
                                                                                                                            - [key: - string]: - any -
                                                                                                                            -
                                                                                                                            • -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          Index
                                                                                                                          -                                                                                                                           -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          Constructors

                                                                                                                          -
                                                                                                                          - - constructor -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          Properties

                                                                                                                          -
                                                                                                                          - - address? - - birthdate? - - email? - - email_verified? - - family_name? - - gender? - - given_name? - - locale? - - middle_name? - - name? - - nickname? - - phone_number? - - phone_number_verified? - - picture? - - preferred_username? - - profile? - - sub? - - updated_at? - - website? - - zoneinfo? -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -

                                                                                                                          Constructors

                                                                                                                          -                                                                                                                           -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                            -
                                                                                                                          • - -
                                                                                                                            -

                                                                                                                            - Returns - User -

                                                                                                                            -
                                                                                                                            -
                                                                                                                            • -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -

                                                                                                                          Properties

                                                                                                                          -                                                                                                                           -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - address?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - birthdate?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - email?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - email_verified?: - boolean -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - family_name?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - gender?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - given_name?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - locale?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - middle_name?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - name?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - nickname?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - phone_number?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - phone_number_verified?: - boolean -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - picture?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - preferred_username?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - profile?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - sub?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - updated_at?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - website?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - zoneinfo?: - string -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -

                                                                                                                          Settings

                                                                                                                          -                                                                                                                           -
                                                                                                                          -
                                                                                                                          - Member Visibility -
                                                                                                                            -
                                                                                                                          • - -
                                                                                                                            • -
                                                                                                                          • - -
                                                                                                                            • -
                                                                                                                          • - -
                                                                                                                            • -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -

                                                                                                                          On This Page

                                                                                                                          -                                                                                                                           -
                                                                                                                          -
                                                                                                                          - - Constructors - - -
                                                                                                                          -
                                                                                                                          - - Properties - - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - +User | @auth0/auth0-angular
                                                                                                                          @auth0/auth0-angular
                                                                                                                            Preparing search index...

                                                                                                                            Class User

                                                                                                                            Indexable

                                                                                                                            • [key: string]: any
                                                                                                                            Index

                                                                                                                            Constructors

                                                                                                                            constructor +

                                                                                                                            Properties

                                                                                                                            act? +address? +birthdate? +email? +email_verified? +family_name? +gender? +given_name? +locale? +middle_name? +name? +nickname? +phone_number? +phone_number_verified? +picture? +preferred_username? +profile? +sub? +updated_at? +website? +zoneinfo? +

                                                                                                                            Constructors

                                                                                                                            Properties

                                                                                                                            act?: ActClaim
                                                                                                                            address?: string
                                                                                                                            birthdate?: string
                                                                                                                            email?: string
                                                                                                                            email_verified?: boolean
                                                                                                                            family_name?: string
                                                                                                                            gender?: string
                                                                                                                            given_name?: string
                                                                                                                            locale?: string
                                                                                                                            middle_name?: string
                                                                                                                            name?: string
                                                                                                                            nickname?: string
                                                                                                                            phone_number?: string
                                                                                                                            phone_number_verified?: boolean
                                                                                                                            picture?: string
                                                                                                                            preferred_username?: string
                                                                                                                            profile?: string
                                                                                                                            sub?: string
                                                                                                                            updated_at?: string
                                                                                                                            website?: string
                                                                                                                            zoneinfo?: string

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            Constructors
                                                                                                                            Properties
                                                                                                                            diff --git a/docs/enums/HttpMethod.html b/docs/enums/HttpMethod.html index ef5e165d..2c6efb4f 100644 --- a/docs/enums/HttpMethod.html +++ b/docs/enums/HttpMethod.html @@ -1,587 +1,8 @@ - - - - - - HttpMethod | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              Preparing search index...
                                                                                                                              -
                                                                                                                              -                                                                                                                               - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -

                                                                                                                              Enumeration HttpMethodConst

                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Defines a common set of HTTP methods.

                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              Index
                                                                                                                              -                                                                                                                               -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Enumeration Members

                                                                                                                              -
                                                                                                                              - - Delete - - Get - - Head - - Patch - - Post - - Put -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - -

                                                                                                                              Enumeration Members

                                                                                                                              -                                                                                                                               -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - Delete: - "DELETE" -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - Get: - "GET" -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - Head: - "HEAD" -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - Patch: - "PATCH" -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              - Post -

                                                                                                                              -
                                                                                                                              - Post: - "POST" -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - Put: - "PUT" -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - -

                                                                                                                              Settings

                                                                                                                              -                                                                                                                               -
                                                                                                                              -
                                                                                                                              - Member Visibility -
                                                                                                                                -
                                                                                                                              • - -
                                                                                                                                • -
                                                                                                                              • - -
                                                                                                                                • -
                                                                                                                              • - -
                                                                                                                                • -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - -

                                                                                                                              On This Page

                                                                                                                              -                                                                                                                               -
                                                                                                                              -
                                                                                                                              - - Enumeration Members - - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - +HttpMethod | @auth0/auth0-angular
                                                                                                                              @auth0/auth0-angular
                                                                                                                                Preparing search index...

                                                                                                                                Enumeration HttpMethodConst

                                                                                                                                Defines a common set of HTTP methods.

                                                                                                                                +
                                                                                                                                Index

                                                                                                                                Enumeration Members

                                                                                                                                Delete +Get +Head +Patch +Post +Put +

                                                                                                                                Enumeration Members

                                                                                                                                Delete: "DELETE"
                                                                                                                                Get: "GET"
                                                                                                                                Head: "HEAD"
                                                                                                                                Patch: "PATCH"

                                                                                                                                Post

                                                                                                                                Post: "POST"
                                                                                                                                Put: "PUT"

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Enumeration Members
                                                                                                                                diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index 55cb2f46..56cba14f 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -1,420 +1,8 @@ - - - - - - ResponseType | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                -
                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  Preparing search index...
                                                                                                                                  -
                                                                                                                                  -                                                                                                                                   - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -

                                                                                                                                  Enumeration ResponseType

                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  - The types of responses expected from the authorization server. -

                                                                                                                                  -
                                                                                                                                    -
                                                                                                                                  • code: used for the standard login flow.
                                                                                                                                    • -
                                                                                                                                  • - connect_code: used for the connect account flow. -
                                                                                                                                    • -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - -
                                                                                                                                  Index
                                                                                                                                  -                                                                                                                                   -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Enumeration Members

                                                                                                                                  -
                                                                                                                                  - - Code - - ConnectCode -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - -

                                                                                                                                  Enumeration Members

                                                                                                                                  -                                                                                                                                   -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  - Code: - "code" -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  - ConnectCode: - "connect_code" -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - -

                                                                                                                                  Settings

                                                                                                                                  -                                                                                                                                   -
                                                                                                                                  -
                                                                                                                                  - Member Visibility -
                                                                                                                                    -
                                                                                                                                  • - -
                                                                                                                                    • -
                                                                                                                                  • - -
                                                                                                                                    • -
                                                                                                                                  • - -
                                                                                                                                    • -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - -

                                                                                                                                  On This Page

                                                                                                                                  -                                                                                                                                   -
                                                                                                                                  -
                                                                                                                                  - - Enumeration Members - - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - +ResponseType | @auth0/auth0-angular
                                                                                                                                  @auth0/auth0-angular
                                                                                                                                    Preparing search index...

                                                                                                                                    Enumeration ResponseType

                                                                                                                                    The types of responses expected from the authorization server.

                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                    • code: used for the standard login flow.
                                                                                                                                      • +
                                                                                                                                    • connect_code: used for the connect account flow.
                                                                                                                                      • +
                                                                                                                                    +
                                                                                                                                    Index

                                                                                                                                    Enumeration Members

                                                                                                                                    Code +ConnectCode +

                                                                                                                                    Enumeration Members

                                                                                                                                    Code: "code"
                                                                                                                                    ConnectCode: "connect_code"

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Enumeration Members
                                                                                                                                    diff --git a/docs/functions/authGuardFn.html b/docs/functions/authGuardFn.html index 981cfd31..8b081943 100644 --- a/docs/functions/authGuardFn.html +++ b/docs/functions/authGuardFn.html @@ -1,334 +1,6 @@ - - - - - - authGuardFn | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      Preparing search index...
                                                                                                                                      -
                                                                                                                                      -                                                                                                                                       - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - -

                                                                                                                                      Function authGuardFn

                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                        -
                                                                                                                                      • - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - Functional AuthGuard to ensure routes can only be accessed - when authenticated. -

                                                                                                                                        -

                                                                                                                                        Note: Should only be used as of Angular 15

                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Parameters

                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                        • - route: - ActivatedRouteSnapshot -
                                                                                                                                          -

                                                                                                                                          - Contains the information about a route associated with - a component loaded in an outlet at a particular moment - in time. -

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        • - state: - RouterStateSnapshot -
                                                                                                                                          -

                                                                                                                                          - Represents the state of the router at a moment in - time. -

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          • -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - Returns Observable<boolean> -

                                                                                                                                        -

                                                                                                                                        - An Observable, indicating if the route can be accessed or not -

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        • -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - - -

                                                                                                                                      Settings

                                                                                                                                      -                                                                                                                                       -
                                                                                                                                      -
                                                                                                                                      - Member Visibility -
                                                                                                                                        -
                                                                                                                                      • - -
                                                                                                                                        • -
                                                                                                                                      • - -
                                                                                                                                        • -
                                                                                                                                      • - -
                                                                                                                                        • -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - - +authGuardFn | @auth0/auth0-angular
                                                                                                                                      @auth0/auth0-angular
                                                                                                                                        Preparing search index...

                                                                                                                                        Function authGuardFn

                                                                                                                                        • Functional AuthGuard to ensure routes can only be accessed when authenticated.

                                                                                                                                          +

                                                                                                                                          Note: Should only be used as of Angular 15

                                                                                                                                          +

                                                                                                                                          Parameters

                                                                                                                                          • route: ActivatedRouteSnapshot

                                                                                                                                            Contains the information about a route associated with a component loaded in an outlet at a particular moment in time.

                                                                                                                                            +
                                                                                                                                          • state: RouterStateSnapshot

                                                                                                                                            Represents the state of the router at a moment in time.

                                                                                                                                            +

                                                                                                                                          Returns Observable<boolean>

                                                                                                                                          An Observable, indicating if the route can be accessed or not

                                                                                                                                          +

                                                                                                                                        Settings

                                                                                                                                        Member Visibility
                                                                                                                                        diff --git a/docs/functions/authHttpInterceptorFn.html b/docs/functions/authHttpInterceptorFn.html index eb901a81..d0306b7d 100644 --- a/docs/functions/authHttpInterceptorFn.html +++ b/docs/functions/authHttpInterceptorFn.html @@ -1,373 +1,7 @@ - - - - - - authHttpInterceptorFn | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          Preparing search index...
                                                                                                                                          -
                                                                                                                                          -                                                                                                                                           - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          Function authHttpInterceptorFn

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                          • - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - Functional AuthHttpInterceptor to include the access token - in matching requests. -

                                                                                                                                            -

                                                                                                                                            Note: Should only be used as of Angular 15

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Parameters

                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • - req: - HttpRequest<any> -
                                                                                                                                              -

                                                                                                                                              - An outgoing HTTP request with an optional typed body. -

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • - handle: - (req: - HttpRequest<unknown>) - => - Observable<HttpEvent<unknown>> -
                                                                                                                                              -

                                                                                                                                              - Represents the next interceptor in an interceptor - chain, or the real backend if there are no further - interceptors. -

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - Returns Observable<HttpEvent<any>> -

                                                                                                                                            -

                                                                                                                                            An Observable representing the intercepted HttpRequest

                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - -

                                                                                                                                          Settings

                                                                                                                                          -                                                                                                                                           -
                                                                                                                                          -
                                                                                                                                          - Member Visibility -
                                                                                                                                            -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          • - -
                                                                                                                                            • -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - +authHttpInterceptorFn | @auth0/auth0-angular
                                                                                                                                          @auth0/auth0-angular
                                                                                                                                            Preparing search index...

                                                                                                                                            Function authHttpInterceptorFn

                                                                                                                                            • Functional AuthHttpInterceptor to include the access token in matching requests.

                                                                                                                                              +

                                                                                                                                              Note: Should only be used as of Angular 15

                                                                                                                                              +

                                                                                                                                              Parameters

                                                                                                                                              • req: HttpRequest<any>

                                                                                                                                                An outgoing HTTP request with an optional typed body.

                                                                                                                                                +
                                                                                                                                              • handle: (req: HttpRequest<unknown>) => Observable<HttpEvent<unknown>>

                                                                                                                                                Represents the next interceptor in an interceptor chain, or the real backend if there are no +further interceptors.

                                                                                                                                                +

                                                                                                                                              Returns Observable<HttpEvent<any>>

                                                                                                                                              An Observable representing the intercepted HttpRequest

                                                                                                                                              +

                                                                                                                                            Settings

                                                                                                                                            Member Visibility
                                                                                                                                            diff --git a/docs/functions/isHttpInterceptorRouteConfig.html b/docs/functions/isHttpInterceptorRouteConfig.html index 9567d029..4c47d941 100644 --- a/docs/functions/isHttpInterceptorRouteConfig.html +++ b/docs/functions/isHttpInterceptorRouteConfig.html @@ -1,323 +1,3 @@ - - - - - - isHttpInterceptorRouteConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                            -
                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              Preparing search index...
                                                                                                                                              -
                                                                                                                                              -                                                                                                                                               - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              Function isHttpInterceptorRouteConfig

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - -

                                                                                                                                              Settings

                                                                                                                                              -                                                                                                                                               -
                                                                                                                                              -
                                                                                                                                              - Member Visibility -
                                                                                                                                                -
                                                                                                                                              • - -
                                                                                                                                                • -
                                                                                                                                              • - -
                                                                                                                                                • -
                                                                                                                                              • - -
                                                                                                                                                • -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - +isHttpInterceptorRouteConfig | @auth0/auth0-angular
                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                Preparing search index...

                                                                                                                                                Function isHttpInterceptorRouteConfig

                                                                                                                                                Settings

                                                                                                                                                Member Visibility
                                                                                                                                                diff --git a/docs/functions/provideAuth0.html b/docs/functions/provideAuth0.html index c93fe096..1c0ca675 100644 --- a/docs/functions/provideAuth0.html +++ b/docs/functions/provideAuth0.html @@ -1,330 +1,10 @@ - - - - - - provideAuth0 | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Preparing search index...
                                                                                                                                                  -
                                                                                                                                                  -                                                                                                                                                   - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -

                                                                                                                                                  Function provideAuth0

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                  • - -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    - Initialize the authentication system. Configuration can - either be specified here, or by calling AuthClientConfig.set - (perhaps from an APP_INITIALIZER factory function). -

                                                                                                                                                    -

                                                                                                                                                    - Note: Should only be used as of Angular 15. This function - returns EnvironmentProviders which ensures it - can only be used at the application/environment level and - cannot be added to a component's providers array (this will - result in a compile-time error). -

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    Parameters

                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                    • - Optionalconfig: - AuthConfig -
                                                                                                                                                      -

                                                                                                                                                      The optional configuration for the SDK.

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      • -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    - Returns - EnvironmentProviders -

                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - 
                                                                                                                                                    bootstrapApplication(AppComponent, {
                                                                                                                                                      providers: [
                                                                                                                                                        provideAuth0(),
                                                                                                                                                      ],
                                                                                                                                                    });
+provideAuth0 | @auth0/auth0-angular
                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                      Preparing search index...
                                                                                                                                                      Function provideAuth0
                                                                                                                                                      • Initialize the authentication system. Configuration can either be specified here,
+or by calling AuthClientConfig.set (perhaps from an APP_INITIALIZER factory function).
                                                                                                                                                        
+
                                                                                                                                                        Note: Should only be used as of Angular 15. This function returns EnvironmentProviders
+which ensures it can only be used at the application/environment level and cannot be
+added to a component's providers array (this will result in a compile-time error).
                                                                                                                                                        
+
                                                                                                                                                        Parameters
                                                                                                                                                        • Optionalconfig: AuthConfig
                                                                                                                                                          The optional configuration for the SDK.
                                                                                                                                                          
+
                                                                                                                                                        Returns EnvironmentProviders
                                                                                                                                                        bootstrapApplication(AppComponent, {
                                                                                                                                                          providers: [
                                                                                                                                                            provideAuth0(),
                                                                                                                                                          ],
                                                                                                                                                        });
 
                                                                                                                                                        
-                  
                                                                                                                                                        
-                
                                                                                                                                                        
-                
-              
                                                                                                                                                        
-            
                                                                                                                                                        • 
-          
                                                                                                                                                      
-        
                                                                                                                                                      
-      
                                                                                                                                                      
-      
                                                                                                                                                      
-        
                                                                                                                                                      
-          
                                                                                                                                                      
-            
                                                                                                                                                      
-              
-                
-                
                                                                                                                                                      Settings
                                                                                                                                                      
-                                                                                                                                                                    
-              
                                                                                                                                                      
-                
                                                                                                                                                      
-                  Member Visibility
-                  
                                                                                                                                                        
-                    
                                                                                                                                                      • 
-                      
-                    
                                                                                                                                                        • 
-                    
                                                                                                                                                      • 
-                      
-                    
                                                                                                                                                        • 
-                    
                                                                                                                                                      • 
-                      
-                    
                                                                                                                                                        • 
-                  
                                                                                                                                                      
-                
                                                                                                                                                      
-                
                                                                                                                                                      
-                  
-                
                                                                                                                                                      
-              
                                                                                                                                                      
-            
                                                                                                                                                      
-          
                                                                                                                                                      
-        
                                                                                                                                                      
-        
                                                                                                                                                      
-          
-        
                                                                                                                                                      
-      
                                                                                                                                                      
-    
                                                                                                                                                      
-    
                                                                                                                                                      
-    
                                                                                                                                                      
-  
-
+
+

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility
                                                                                                                                                    diff --git a/docs/hierarchy.html b/docs/hierarchy.html index e58b9e7c..9121051c 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,465 +1 @@ - - - - - - @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      Preparing search index...
                                                                                                                                                      -
                                                                                                                                                      -                                                                                                                                                       - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      @auth0/auth0-angular

                                                                                                                                                      -

                                                                                                                                                      Hierarchy Summary

                                                                                                                                                      - - - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - - -

                                                                                                                                                      Settings

                                                                                                                                                      -                                                                                                                                                       -
                                                                                                                                                      -
                                                                                                                                                      - Member Visibility -
                                                                                                                                                        -
                                                                                                                                                      • - -
                                                                                                                                                        • -
                                                                                                                                                      • - -
                                                                                                                                                        • -
                                                                                                                                                      • - -
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - - +@auth0/auth0-angular
                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                        Preparing search index...

                                                                                                                                                        @auth0/auth0-angular

                                                                                                                                                        Hierarchy Summary

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility
                                                                                                                                                        diff --git a/docs/index.html b/docs/index.html index 815a225d..300286b5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,760 +1,116 @@ - - - - - - @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          Preparing search index...
                                                                                                                                                          -
                                                                                                                                                          -                                                                                                                                                           - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          @auth0/auth0-angular

                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Auth0 SDK for Angular Single Page Applications -

                                                                                                                                                          -

                                                                                                                                                          - A library for integrating Auth0 into - an Angular application. -

                                                                                                                                                          -

                                                                                                                                                          - Release - Codecov - Ask DeepWiki - Downloads - License - CircleCI -

                                                                                                                                                          -

                                                                                                                                                          - 📚 Documentation - 🚀 - Getting Started - 💻 - API Reference - 💬 - Feedback -

                                                                                                                                                          - -
                                                                                                                                                            -
                                                                                                                                                          • - Quickstart - - our interactive guide for quickly adding login, logout and user - information to an Angular app using Auth0. -
                                                                                                                                                            • -
                                                                                                                                                          • - Sample App - - a full-fledged Angular application integrated with Auth0. -
                                                                                                                                                            • -
                                                                                                                                                          • - FAQs - - frequently asked questions about the auth0-angular SDK. -
                                                                                                                                                            • -
                                                                                                                                                          • - Examples - - code samples for common Angular authentication scenario's. -
                                                                                                                                                            • -
                                                                                                                                                          • - Docs site - explore our - docs site and learn more about Auth0. -
                                                                                                                                                            • -
                                                                                                                                                          - - -

                                                                                                                                                          - This project only supports the - actively supported versions of Angular as stated in the Angular - documentation. Whilst other versions might be compatible they are not actively - supported. -

                                                                                                                                                          - -

                                                                                                                                                          Using npm:

                                                                                                                                                          - 
                                                                                                                                                          npm install @auth0/auth0-angular
+@auth0/auth0-angular
                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                            Preparing search index...
                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                            Auth0 SDK for Angular Single Page Applications
                                                                                                                                                            
+
                                                                                                                                                            A library for integrating Auth0 into an Angular application.
                                                                                                                                                            
+
                                                                                                                                                            Release
+Codecov
+Ask DeepWiki
+Downloads
+License
+CircleCI
                                                                                                                                                            
+
                                                                                                                                                            📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback
                                                                                                                                                            
+
+
                                                                                                                                                              
+
                                                                                                                                                            • Quickstart - our interactive guide for quickly adding login, logout and user information to an Angular app using Auth0.
                                                                                                                                                              • 
+
                                                                                                                                                            • Sample App - a full-fledged Angular application integrated with Auth0.
                                                                                                                                                              • 
+
                                                                                                                                                            • FAQs - frequently asked questions about the auth0-angular SDK.
                                                                                                                                                              • 
+
                                                                                                                                                            • Examples - code samples for common Angular authentication scenario's.
                                                                                                                                                              • 
+
                                                                                                                                                            • Docs site - explore our docs site and learn more about Auth0.
                                                                                                                                                              • 
+
                                                                                                                                                            
+
+
+
                                                                                                                                                            This project only supports the actively supported versions of Angular as stated in the Angular documentation. Whilst other versions might be compatible they are not actively supported.
                                                                                                                                                            
+
+
                                                                                                                                                            Using npm:
                                                                                                                                                            
+
                                                                                                                                                            npm install @auth0/auth0-angular
 
                                                                                                                                                            
 
-          
                                                                                                                                                            
-            We also have ng-add support, so the library can also be
-            installed using the Angular CLI:
-          
                                                                                                                                                            
-          
                                                                                                                                                            ng add @auth0/auth0-angular
+
                                                                                                                                                            We also have ng-add support, so the library can also be installed using the Angular CLI:
                                                                                                                                                            
+
                                                                                                                                                            ng add @auth0/auth0-angular
 
                                                                                                                                                            
 
-          
-          
                                                                                                                                                            
-            Create a Single Page Application in the
-            Auth0 Dashboard.
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            
                                                                                                                                                            
-              If you're using an existing application, verify
-              that you have configured the following settings in your Single
-              Page Application:
-            
                                                                                                                                                            
-            
                                                                                                                                                              
-              
                                                                                                                                                            • 
-                Click on the "Settings" tab of your application's
-                page.
-              
                                                                                                                                                              • 
-              
                                                                                                                                                            • 
-                Scroll down and click on the "Show Advanced Settings"
-                link.
-              
                                                                                                                                                              • 
-              
                                                                                                                                                            • 
-                Under "Advanced Settings", click on the
-                "OAuth" tab.
-              
                                                                                                                                                              • 
-              
                                                                                                                                                            • 
-                Ensure that "JsonWebToken Signature Algorithm" is set
-                to RS256 and that "OIDC Conformant" is
-                enabled.
-              
                                                                                                                                                              • 
-            
                                                                                                                                                            
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            Next, configure the following URLs for your application under the
-            "Application URIs" section of the "Settings"
-            page:
-          
                                                                                                                                                            
-          
                                                                                                                                                              
-            
                                                                                                                                                            • 
-              Allowed Callback URLs:
-              http://localhost:4200
-            
                                                                                                                                                              • 
-            
                                                                                                                                                            • 
-              Allowed Logout URLs:
-              http://localhost:4200
-            
                                                                                                                                                              • 
-            
                                                                                                                                                            • 
-              Allowed Web Origins:
-              http://localhost:4200
-            
                                                                                                                                                              • 
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            
                                                                                                                                                            
-              These URLs should reflect the origins that your application is
-              running on. Allowed Callback URLs may also
-              include a path, depending on where you're handling the callback.
-            
                                                                                                                                                            
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            Take note of the Client ID and
-            Domain values under the "Basic
-            Information" section. You'll need these values in the next
-            step.
-          
                                                                                                                                                            
-          
-          
-          
                                                                                                                                                            
-            The recommended approach is to use the functional
-            provideAuth0() in your application configuration:
-          
                                                                                                                                                            
-          
                                                                                                                                                            import { ApplicationConfig } from '@angular/core';
                                                                                                                                                            import { provideAuth0 } from '@auth0/auth0-angular';

                                                                                                                                                            export const appConfig: ApplicationConfig = {
                                                                                                                                                              providers: [
                                                                                                                                                                provideAuth0({
                                                                                                                                                                  domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                  clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                  authorizationParams: {
                                                                                                                                                                    redirect_uri: window.location.origin,
                                                                                                                                                                  },
                                                                                                                                                                }),
                                                                                                                                                              ],
                                                                                                                                                            };
+
+
                                                                                                                                                            Create a Single Page Application in the Auth0 Dashboard.
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            If you're using an existing application, verify that you have configured the following settings in your Single Page Application:
                                                                                                                                                            
+
                                                                                                                                                              
+
                                                                                                                                                            • Click on the "Settings" tab of your application's page.
                                                                                                                                                              • 
+
                                                                                                                                                            • Scroll down and click on the "Show Advanced Settings" link.
                                                                                                                                                              • 
+
                                                                                                                                                            • Under "Advanced Settings", click on the "OAuth" tab.
                                                                                                                                                              • 
+
                                                                                                                                                            • Ensure that "JsonWebToken Signature Algorithm" is set to RS256 and that "OIDC Conformant" is enabled.
                                                                                                                                                              • 
+
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            Next, configure the following URLs for your application under the "Application URIs" section of the "Settings" page:
                                                                                                                                                            
+
                                                                                                                                                              
+
                                                                                                                                                            • Allowed Callback URLs: http://localhost:4200
                                                                                                                                                              • 
+
                                                                                                                                                            • Allowed Logout URLs: http://localhost:4200
                                                                                                                                                              • 
+
                                                                                                                                                            • Allowed Web Origins: http://localhost:4200
                                                                                                                                                              • 
+
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            These URLs should reflect the origins that your application is running on. Allowed Callback URLs may also include a path, depending on where you're handling the callback.
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            Take note of the Client ID and Domain values under the "Basic Information" section. You'll need these values in the next step.
                                                                                                                                                            
+
+
+
                                                                                                                                                            The recommended approach is to use the functional provideAuth0() in your application configuration:
                                                                                                                                                            
+
                                                                                                                                                            import { ApplicationConfig } from '@angular/core';
                                                                                                                                                            import { provideAuth0 } from '@auth0/auth0-angular';

                                                                                                                                                            export const appConfig: ApplicationConfig = {
                                                                                                                                                              providers: [
                                                                                                                                                                provideAuth0({
                                                                                                                                                                  domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                  clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                  authorizationParams: {
                                                                                                                                                                    redirect_uri: window.location.origin,
                                                                                                                                                                  },
                                                                                                                                                                }),
                                                                                                                                                              ],
                                                                                                                                                            };
 
                                                                                                                                                            
 
-          
                                                                                                                                                            
-            Using NgModules
-            
                                                                                                                                                            
-              If you're using NgModules, you can configure the SDK using
-              AuthModule.forRoot():
-            
                                                                                                                                                            
-            
                                                                                                                                                            import { NgModule } from '@angular/core';
                                                                                                                                                            import { AuthModule } from '@auth0/auth0-angular';

                                                                                                                                                            @NgModule({
                                                                                                                                                              imports: [
                                                                                                                                                                AuthModule.forRoot({
                                                                                                                                                                  domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                  clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                  authorizationParams: {
                                                                                                                                                                    redirect_uri: window.location.origin,
                                                                                                                                                                  },
                                                                                                                                                                }),
                                                                                                                                                              ],
                                                                                                                                                            })
                                                                                                                                                            export class AppModule {}
+
                                                                                                                                                            
+Using NgModules
+
                                                                                                                                                            If you're using NgModules, you can configure the SDK using AuthModule.forRoot():
                                                                                                                                                            
+
                                                                                                                                                            import { NgModule } from '@angular/core';
                                                                                                                                                            import { AuthModule } from '@auth0/auth0-angular';

                                                                                                                                                            @NgModule({
                                                                                                                                                              imports: [
                                                                                                                                                                AuthModule.forRoot({
                                                                                                                                                                  domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                  clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                  authorizationParams: {
                                                                                                                                                                    redirect_uri: window.location.origin,
                                                                                                                                                                  },
                                                                                                                                                                }),
                                                                                                                                                              ],
                                                                                                                                                            })
                                                                                                                                                            export class AppModule {}
 
                                                                                                                                                            
-          
                                                                                                                                                            
-          
-          
                                                                                                                                                            
-            Instead of providing static configuration, you can use
-            provideAppInitializer to load your config from an
-            external source before the SDK is instantiated, and configure it
-            using AuthClientConfig.set.
-          
                                                                                                                                                            
-          
                                                                                                                                                            import { ApplicationConfig, inject, provideAppInitializer } from '@angular/core';
                                                                                                                                                            import { provideHttpClient, HttpBackend, HttpClient } from '@angular/common/http';
                                                                                                                                                            import { provideAuth0, AuthClientConfig } from '@auth0/auth0-angular';

                                                                                                                                                            export function configInitializer(handler: HttpBackend, config: AuthClientConfig) {
                                                                                                                                                              return () =>
                                                                                                                                                                new HttpClient(handler)
                                                                                                                                                                  .get('/config')
                                                                                                                                                                  .toPromise()
                                                                                                                                                                  .then((loadedConfig: any) => config.set(loadedConfig));
                                                                                                                                                            }

                                                                                                                                                            export const appConfig: ApplicationConfig = {
                                                                                                                                                              providers: [
                                                                                                                                                                provideHttpClient(),
                                                                                                                                                                provideAuth0(),
                                                                                                                                                                provideAppInitializer(() => {
                                                                                                                                                                  const handler = inject(HttpBackend);
                                                                                                                                                                  const config = inject(AuthClientConfig);
                                                                                                                                                                  return configInitializer(handler, config)();
                                                                                                                                                                }),
                                                                                                                                                              ],
                                                                                                                                                            };
+
+
                                                                                                                                                            
+
+
                                                                                                                                                            Instead of providing static configuration, you can use provideAppInitializer to load your config from an external source before the SDK is instantiated, and configure it using AuthClientConfig.set.
                                                                                                                                                            
+
                                                                                                                                                            import { ApplicationConfig, inject, provideAppInitializer } from '@angular/core';
                                                                                                                                                            import { provideHttpClient, HttpBackend, HttpClient } from '@angular/common/http';
                                                                                                                                                            import { provideAuth0, AuthClientConfig } from '@auth0/auth0-angular';

                                                                                                                                                            export function configInitializer(handler: HttpBackend, config: AuthClientConfig) {
                                                                                                                                                              return () =>
                                                                                                                                                                new HttpClient(handler)
                                                                                                                                                                  .get('/config')
                                                                                                                                                                  .toPromise()
                                                                                                                                                                  .then((loadedConfig: any) => config.set(loadedConfig));
                                                                                                                                                            }

                                                                                                                                                            export const appConfig: ApplicationConfig = {
                                                                                                                                                              providers: [
                                                                                                                                                                provideHttpClient(),
                                                                                                                                                                provideAuth0(),
                                                                                                                                                                provideAppInitializer(() => {
                                                                                                                                                                  const handler = inject(HttpBackend);
                                                                                                                                                                  const config = inject(AuthClientConfig);
                                                                                                                                                                  return configInitializer(handler, config)();
                                                                                                                                                                }),
                                                                                                                                                              ],
                                                                                                                                                            };
 
                                                                                                                                                            
 
-          
                                                                                                                                                            
-            
                                                                                                                                                            
-              Important: The configuration will only be used
-              initially when the SDK is instantiated. Any changes made to the
-              configuration at a later moment in time will have no effect on the
-              default options used when calling the SDK's methods. This is why
-              the dynamic configuration should be set using an app initializer,
-              which ensures the configuration is available prior to
-              instantiating the SDK.
-            
                                                                                                                                                            
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            
                                                                                                                                                            
-              :information_source: Any request made through an instance of
-              HttpClient that got instantiated by Angular will use
-              all configured interceptors, including our
-              AuthHttpInterceptor. Because the
-              AuthHttpInterceptor requires the existence of
-              configuration settings, the request for retrieving those dynamic
-              configuration settings should ensure it's not using any
-              interceptors. In Angular, this can be done by manually
-              instantiating HttpClient using an injected
-              HttpBackend instance.
-            
                                                                                                                                                            
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            Using NgModules
-            
                                                                                                                                                            
-              Instead of using AuthModule.forRoot to specify auth
-              configuration, you can provide a factory function using
-              APP_INITIALIZER to load your config from an external
-              source before the auth module is loaded, and provide your
-              configuration using AuthClientConfig.set.
-            
                                                                                                                                                            
-            
                                                                                                                                                            import { APP_INITIALIZER } from '@angular/core';
                                                                                                                                                            import { HttpClientModule, HttpClient, HttpBackend } from '@angular/common/http';
                                                                                                                                                            import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

                                                                                                                                                            function configInitializer(handler: HttpBackend, config: AuthClientConfig) {
                                                                                                                                                              return () =>
                                                                                                                                                                new HttpClient(handler)
                                                                                                                                                                  .get('/config')
                                                                                                                                                                  .toPromise()
                                                                                                                                                                  .then((loadedConfig: any) => config.set(loadedConfig));
                                                                                                                                                            }

                                                                                                                                                            @NgModule({
                                                                                                                                                              imports: [HttpClientModule, AuthModule.forRoot()],
                                                                                                                                                              providers: [
                                                                                                                                                                {
                                                                                                                                                                  provide: APP_INITIALIZER,
                                                                                                                                                                  useFactory: configInitializer,
                                                                                                                                                                  deps: [HttpBackend, AuthClientConfig],
                                                                                                                                                                  multi: true,
                                                                                                                                                                },
                                                                                                                                                              ],
                                                                                                                                                            })
                                                                                                                                                            export class AppModule {}
+
                                                                                                                                                            
+
                                                                                                                                                            Important: The configuration will only be used initially when the SDK is instantiated. Any changes made to the configuration at a later moment in time will have no effect on the default options used when calling the SDK's methods. This is why the dynamic configuration should be set using an app initializer, which ensures the configuration is available prior to instantiating the SDK.
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            :information_source: Any request made through an instance of HttpClient that got instantiated by Angular will use all configured interceptors, including our AuthHttpInterceptor. Because the AuthHttpInterceptor requires the existence of configuration settings, the request for retrieving those dynamic configuration settings should ensure it's not using any interceptors. In Angular, this can be done by manually instantiating HttpClient using an injected HttpBackend instance.
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            
+Using NgModules
+
                                                                                                                                                            Instead of using AuthModule.forRoot to specify auth configuration, you can provide a factory function using APP_INITIALIZER to load your config from an external source before the auth module is loaded, and provide your configuration using AuthClientConfig.set.
                                                                                                                                                            
+
                                                                                                                                                            import { APP_INITIALIZER } from '@angular/core';
                                                                                                                                                            import { HttpClientModule, HttpClient, HttpBackend } from '@angular/common/http';
                                                                                                                                                            import { AuthModule, AuthClientConfig } from '@auth0/auth0-angular';

                                                                                                                                                            function configInitializer(handler: HttpBackend, config: AuthClientConfig) {
                                                                                                                                                              return () =>
                                                                                                                                                                new HttpClient(handler)
                                                                                                                                                                  .get('/config')
                                                                                                                                                                  .toPromise()
                                                                                                                                                                  .then((loadedConfig: any) => config.set(loadedConfig));
                                                                                                                                                            }

                                                                                                                                                            @NgModule({
                                                                                                                                                              imports: [HttpClientModule, AuthModule.forRoot()],
                                                                                                                                                              providers: [
                                                                                                                                                                {
                                                                                                                                                                  provide: APP_INITIALIZER,
                                                                                                                                                                  useFactory: configInitializer,
                                                                                                                                                                  deps: [HttpBackend, AuthClientConfig],
                                                                                                                                                                  multi: true,
                                                                                                                                                                },
                                                                                                                                                              ],
                                                                                                                                                            })
                                                                                                                                                            export class AppModule {}
 
                                                                                                                                                            
-          
                                                                                                                                                            
-          
-          
                                                                                                                                                            
-            To log the user into the application, inject the
-            AuthService and call its
-            loginWithRedirect method.
-          
                                                                                                                                                            
-          
                                                                                                                                                            import { Component } from '@angular/core';
                                                                                                                                                            import { AuthService } from '@auth0/auth0-angular';

                                                                                                                                                            @Component({
                                                                                                                                                              selector: 'app-root',
                                                                                                                                                              templateUrl: './app.component.html',
                                                                                                                                                              styleUrls: ['./app.component.css'],
                                                                                                                                                            })
                                                                                                                                                            export class AppComponent {
                                                                                                                                                              constructor(public auth: AuthService) {}

                                                                                                                                                              loginWithRedirect() {
                                                                                                                                                                this.auth.loginWithRedirect();
                                                                                                                                                              }
+
+
                                                                                                                                                            
+
+
                                                                                                                                                            To log the user into the application, inject the AuthService and call its loginWithRedirect method.
                                                                                                                                                            
+
                                                                                                                                                            import { Component } from '@angular/core';
                                                                                                                                                            import { AuthService } from '@auth0/auth0-angular';

                                                                                                                                                            @Component({
                                                                                                                                                              selector: 'app-root',
                                                                                                                                                              templateUrl: './app.component.html',
                                                                                                                                                              styleUrls: ['./app.component.css'],
                                                                                                                                                            })
                                                                                                                                                            export class AppComponent {
                                                                                                                                                              constructor(public auth: AuthService) {}

                                                                                                                                                              loginWithRedirect() {
                                                                                                                                                                this.auth.loginWithRedirect();
                                                                                                                                                              }
 
                                                                                                                                                            
 
-          
                                                                                                                                                            
-            By default the application will ask Auth0 to redirect back to the
-            root URL of your application after authentication. This can be
-            configured by setting the
-            redirectUri
-            option.
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            For more code samples on how to integrate the
-            auth0-angular SDK in your
-            Angular application, including how to use our
-            standalone and function APIs, have a look at the
-            examples.
-          
                                                                                                                                                            
-          
-          
                                                                                                                                                            Explore public API's available in auth0-angular.
                                                                                                                                                            
-          
                                                                                                                                                              
-            
                                                                                                                                                            • 
-              AuthService
-              - service used to interact with the SDK.
-            
                                                                                                                                                              • 
-            
                                                                                                                                                            • 
-              AuthConfig
-              - used to configure the SDK.
-            
                                                                                                                                                              • 
-          
                                                                                                                                                            
-          
-          
-          
                                                                                                                                                            
-            We appreciate feedback and contribution to this repo! Before you get
-            started, please see the following:
-          
                                                                                                                                                            
-          
-          
-          
                                                                                                                                                            
-            To provide feedback or report a bug, please
-            raise an issue on our issue tracker.
-          
                                                                                                                                                            
-          
-          
                                                                                                                                                            
-            Please do not report security vulnerabilities on the public GitHub
-            issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            
-              
-              
-              Auth0 Logo
-            
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            Auth0 is an easy to implement, adaptable authentication and
-            authorization platform. To learn more checkout
-            Why Auth0?
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            This project is licensed under the MIT license. See the
-            
-              LICENSE
-            file for more info.
-          
                                                                                                                                                            
-        
                                                                                                                                                            
-      
                                                                                                                                                            
-      
                                                                                                                                                            
-        
                                                                                                                                                            
-          
                                                                                                                                                            
-            
                                                                                                                                                            
-              
-                
-                
                                                                                                                                                            Settings
                                                                                                                                                            
-                                                                                                                                                                          
-              
                                                                                                                                                            
-                
                                                                                                                                                            
-                  Member Visibility
-                  
                                                                                                                                                              
-                    
                                                                                                                                                            • 
-                      
-                    
                                                                                                                                                              • 
-                    
                                                                                                                                                            • 
-                      
-                    
                                                                                                                                                              • 
-                    
                                                                                                                                                            • 
-                      
-                    
                                                                                                                                                              • 
-                  
                                                                                                                                                            
-                
                                                                                                                                                            
-                
                                                                                                                                                            
-                  
-                
                                                                                                                                                            
-              
                                                                                                                                                            
-            
                                                                                                                                                            
-          
                                                                                                                                                            
-          
                                                                                                                                                            
-            
-              
-              
                                                                                                                                                            On This Page
                                                                                                                                                            
-                                                                                                                                                                        
-            
                                                                                                                                                            
-              DocumentationGetting started
-              
-              API referenceFeedback
-              
-            
                                                                                                                                                            
-          
                                                                                                                                                            
-        
                                                                                                                                                            
-        
                                                                                                                                                            
-          
-        
                                                                                                                                                            
-      
                                                                                                                                                            
-    
                                                                                                                                                            
-    
                                                                                                                                                            
-    
                                                                                                                                                            
-  
-
+
                                                                                                                                                            By default the application will ask Auth0 to redirect back to the root URL of your application after authentication. This can be configured by setting the redirectUri option.
                                                                                                                                                            
+
                                                                                                                                                            For more code samples on how to integrate the auth0-angular SDK in your Angular application, including how to use our standalone and function APIs, have a look at the examples.
                                                                                                                                                            
+
+
                                                                                                                                                            Explore public API's available in auth0-angular.
                                                                                                                                                            
+
+
+
+
                                                                                                                                                            We appreciate feedback and contribution to this repo! Before you get started, please see the following:
                                                                                                                                                            
+
+
+
                                                                                                                                                            To provide feedback or report a bug, please raise an issue on our issue tracker.
                                                                                                                                                            
+
+
                                                                                                                                                            Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
                                                                                                                                                            
+
                                                                                                                                                            
+
                                                                                                                                                            
+  
+    
+    
+    Auth0 Logo
+  
+
                                                                                                                                                            
+
                                                                                                                                                            Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
                                                                                                                                                            
+
                                                                                                                                                            
+This project is licensed under the MIT license. See the  LICENSE file for more info.

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            DocumentationGetting startedAPI referenceFeedback
                                                                                                                                                            diff --git a/docs/interfaces/AppState.html b/docs/interfaces/AppState.html index 80e94a3b..914e56b7 100644 --- a/docs/interfaces/AppState.html +++ b/docs/interfaces/AppState.html @@ -1,551 +1,12 @@ - - - - - - AppState | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              Preparing search index...
                                                                                                                                                              -
                                                                                                                                                              -                                                                                                                                                               - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -

                                                                                                                                                              Interface AppState

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              - Angular specific state to be stored before redirect and any - account that the user may have connected to. -

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - interface - AppState - {
                                                                                                                                                                  connectedAccount?: - ConnectedAccount;
                                                                                                                                                                  response_type?: - ResponseType;
                                                                                                                                                                  target?: - string;
                                                                                                                                                                  [key: - string]: - any;
                                                                                                                                                              } -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Indexable

                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                              • -
                                                                                                                                                                - [key: - string]: - any -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Any custom parameter to be stored in appState

                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -
                                                                                                                                                              Index
                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Properties

                                                                                                                                                              -
                                                                                                                                                              - - connectedAccount? - - response_type? - - target? -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -

                                                                                                                                                              Properties

                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              - connectedAccount?: - ConnectedAccount -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              - The connected account information when the user has completed - a connect account flow. -

                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              - response_type?: - ResponseType -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              - The response type returned from the authentication server. -

                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              - target?: - string -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              - Target path the app gets routed to after handling the callback - from Auth0 (defaults to '/') -

                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -

                                                                                                                                                              Settings

                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -
                                                                                                                                                              - Member Visibility -
                                                                                                                                                                -
                                                                                                                                                              • - -
                                                                                                                                                                • -
                                                                                                                                                              • - -
                                                                                                                                                                • -
                                                                                                                                                              • - -
                                                                                                                                                                • -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -

                                                                                                                                                              On This Page

                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -
                                                                                                                                                              - - Properties - - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - +AppState | @auth0/auth0-angular
                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface AppState

                                                                                                                                                                Angular specific state to be stored before redirect +and any account that the user may have connected to.

                                                                                                                                                                +
                                                                                                                                                                interface AppState {
                                                                                                                                                                    connectedAccount?: ConnectedAccount;
                                                                                                                                                                    response_type?: ResponseType;
                                                                                                                                                                    target?: string;
                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                }

                                                                                                                                                                Indexable

                                                                                                                                                                • [key: string]: any

                                                                                                                                                                  Any custom parameter to be stored in appState

                                                                                                                                                                  +
                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                connectedAccount? +response_type? +target? +

                                                                                                                                                                Properties

                                                                                                                                                                connectedAccount?: ConnectedAccount

                                                                                                                                                                The connected account information when the user has completed +a connect account flow.

                                                                                                                                                                +
                                                                                                                                                                response_type?: ResponseType

                                                                                                                                                                The response type returned from the authentication server.

                                                                                                                                                                +
                                                                                                                                                                target?: string

                                                                                                                                                                Target path the app gets routed to after +handling the callback from Auth0 (defaults to '/')

                                                                                                                                                                +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                On This Page

                                                                                                                                                                Properties
                                                                                                                                                                diff --git a/docs/interfaces/AuthConfig.html b/docs/interfaces/AuthConfig.html index 9b428d6a..b1ae338f 100644 --- a/docs/interfaces/AuthConfig.html +++ b/docs/interfaces/AuthConfig.html @@ -1,2279 +1,140 @@ - - - - - - AuthConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  Preparing search index...
                                                                                                                                                                  -
                                                                                                                                                                  -                                                                                                                                                                   - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -

                                                                                                                                                                  Interface AuthConfig

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Configuration for the authentication service

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - interface - AuthConfig - {
                                                                                                                                                                      auth0Client?: - {
                                                                                                                                                                          env?: - { - [key: - string]: - string - };
                                                                                                                                                                          name: - string;
                                                                                                                                                                          version: - string;
                                                                                                                                                                      };
                                                                                                                                                                      authorizationParams?: - ClientAuthorizationParams;
                                                                                                                                                                      authorizeTimeoutInSeconds?: - number;
                                                                                                                                                                      cache?: - ICache;
                                                                                                                                                                      cacheLocation?: - CacheLocation;
                                                                                                                                                                      clientId: - string;
                                                                                                                                                                      cookieDomain?: - string;
                                                                                                                                                                      domain: - string;
                                                                                                                                                                      errorPath?: - string;
                                                                                                                                                                      httpInterceptor?: - HttpInterceptorConfig;
                                                                                                                                                                      httpTimeoutInSeconds?: - number;
                                                                                                                                                                      interactiveErrorHandler?: - "popup";
                                                                                                                                                                      issuer?: - string;
                                                                                                                                                                      leeway?: - number;
                                                                                                                                                                      legacySameSiteCookie?: - boolean;
                                                                                                                                                                      nowProvider?: - () - => - number - | - Promise<number>;
                                                                                                                                                                      sessionCheckExpiryDays?: - number;
                                                                                                                                                                      sessionTransferTokenQueryParamName?: - string;
                                                                                                                                                                      skipRedirectCallback?: - boolean;
                                                                                                                                                                      useCookiesForTransactions?: - boolean;
                                                                                                                                                                      useDpop?: - boolean;
                                                                                                                                                                      useFormData?: - boolean;
                                                                                                                                                                      useMrrt?: - boolean;
                                                                                                                                                                      useRefreshTokens?: - boolean;
                                                                                                                                                                      useRefreshTokensFallback?: - boolean;
                                                                                                                                                                      workerUrl?: - string;
                                                                                                                                                                  } -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Hierarchy

                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • - Auth0ClientOptions -
                                                                                                                                                                      -
                                                                                                                                                                    • - AuthConfig -
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                    • -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - -
                                                                                                                                                                  Index
                                                                                                                                                                  -                                                                                                                                                                   -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Properties

                                                                                                                                                                  -
                                                                                                                                                                  - - auth0Client? - - authorizationParams? - - authorizeTimeoutInSeconds? - - cache? - - cacheLocation? - - clientId - - cookieDomain? - - domain - - errorPath? - - httpInterceptor? - - httpTimeoutInSeconds? - - interactiveErrorHandler? - - issuer? - - leeway? - - legacySameSiteCookie? - - nowProvider? - - sessionCheckExpiryDays? - - sessionTransferTokenQueryParamName? - - skipRedirectCallback? - - useCookiesForTransactions? - - useDpop? - - useFormData? - - useMrrt? - - useRefreshTokens? - - useRefreshTokensFallback? - - workerUrl? -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - -

                                                                                                                                                                  Properties

                                                                                                                                                                  -                                                                                                                                                                   -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - auth0Client?: - { - env?: - { - [key: - string]: - string - }; - name: - string; - version: - string - } -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Internal property to send information about the client to the - authorization server. -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - authorizationParams?: - ClientAuthorizationParams -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - URL parameters that will be sent back to the Authorization - Server. This can be known parameters defined by Auth0 or - custom parameters that you define. -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - authorizeTimeoutInSeconds?: - number -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - A maximum number of seconds to wait before declaring - background calls to /authorize as failed for timeout Defaults - to 60s. -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - cache?: - ICache -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Specify a custom cache implementation to use for token storage - and retrieval. This setting takes precedence over - cacheLocation if they are both specified. -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - cacheLocation?: - CacheLocation -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - The location to use when storing cache data. Valid values are - memory or localstorage. The default - setting is memory. -

                                                                                                                                                                  -

                                                                                                                                                                  - Read more about - changing storage options in the Auth0 docs -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - clientId: - string -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  The Client ID found on your Application settings page

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - cookieDomain?: - string -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - The domain the cookie is accessible from. If not set, the - cookie is scoped to the current domain, including the - subdomain. -

                                                                                                                                                                  -

                                                                                                                                                                  - Note: setting this incorrectly may cause silent authentication - to stop working on page load. -

                                                                                                                                                                  -

                                                                                                                                                                  - To keep a user logged in across multiple subdomains set this - to your top-level domain and prefixed with a - . (eg: .example.com). -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - domain: - string -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Your Auth0 account domain such as - 'example.auth0.com', - 'example.eu.auth0.com' or , - 'example.mycompany.com' (when using - custom domains) -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - errorPath?: - string -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Path in your application to redirect to when the Authorization - server returns an error. Defaults to / -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - httpInterceptor?: - HttpInterceptorConfig -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Configuration for the built-in Http Interceptor, used for - automatically attaching access tokens. -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - httpTimeoutInSeconds?: - number -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Specify the timeout for HTTP calls using fetch. - The default is 10 seconds. -

                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - interactiveErrorHandler?: - "popup" -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Configures automatic handling of interactive authentication - errors. -

                                                                                                                                                                  -

                                                                                                                                                                  - When set, the SDK intercepts mfa_required errors - from getTokenSilently() and handles them - automatically instead of throwing to the caller. -

                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                  • - 'popup': Opens Universal Login in a popup to - complete MFA. The original - authorizationParams (audience, scope) are - preserved. On success, the token is returned. On failure, - popup errors are thrown. -
                                                                                                                                                                    • -
                                                                                                                                                                  -

                                                                                                                                                                  - This option only affects getTokenSilently(). - Other methods are not affected. -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - 
                                                                                                                                                                  undefined (MFA errors are thrown to the caller)
+AuthConfig | @auth0/auth0-angular
                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    Interface AuthConfig
                                                                                                                                                                    Configuration for the authentication service
                                                                                                                                                                    
+
                                                                                                                                                                    interface AuthConfig {
                                                                                                                                                                        auth0Client?: {
                                                                                                                                                                            env?: { [key: string]: string };
                                                                                                                                                                            name: string;
                                                                                                                                                                            version: string;
                                                                                                                                                                        };
                                                                                                                                                                        authorizationParams?: ClientAuthorizationParams;
                                                                                                                                                                        authorizeTimeoutInSeconds?: number;
                                                                                                                                                                        cache?: ICache;
                                                                                                                                                                        cacheLocation?: CacheLocation;
                                                                                                                                                                        clientId: string;
                                                                                                                                                                        cookieDomain?: string;
                                                                                                                                                                        domain: string;
                                                                                                                                                                        errorPath?: string;
                                                                                                                                                                        httpInterceptor?: HttpInterceptorConfig;
                                                                                                                                                                        httpTimeoutInSeconds?: number;
                                                                                                                                                                        interactiveErrorHandler?: "popup";
                                                                                                                                                                        issuer?: string;
                                                                                                                                                                        leeway?: number;
                                                                                                                                                                        legacySameSiteCookie?: boolean;
                                                                                                                                                                        nowProvider?: () => number | Promise<number>;
                                                                                                                                                                        sessionCheckExpiryDays?: number;
                                                                                                                                                                        sessionTransferTokenQueryParamName?: string;
                                                                                                                                                                        skipRedirectCallback?: boolean;
                                                                                                                                                                        useCookiesForTransactions?: boolean;
                                                                                                                                                                        useDpop?: boolean;
                                                                                                                                                                        useFormData?: boolean;
                                                                                                                                                                        useMrrt?: boolean;
                                                                                                                                                                        useRefreshTokens?: boolean;
                                                                                                                                                                        useRefreshTokensFallback?: boolean;
                                                                                                                                                                        workerUrl?: string;
                                                                                                                                                                    }
                                                                                                                                                                    Hierarchy
                                                                                                                                                                    • Auth0ClientOptions
                                                                                                                                                                      • AuthConfig
                                                                                                                                                                    Index
                                                                                                                                                                    Properties
                                                                                                                                                                    auth0Client?
+authorizationParams?
+authorizeTimeoutInSeconds?
+cache?
+cacheLocation?
+clientId
+cookieDomain?
+domain
+errorPath?
+httpInterceptor?
+httpTimeoutInSeconds?
+interactiveErrorHandler?
+issuer?
+leeway?
+legacySameSiteCookie?
+nowProvider?
+sessionCheckExpiryDays?
+sessionTransferTokenQueryParamName?
+skipRedirectCallback?
+useCookiesForTransactions?
+useDpop?
+useFormData?
+useMrrt?
+useRefreshTokens?
+useRefreshTokensFallback?
+workerUrl?
+
                                                                                                                                                                    Properties
                                                                                                                                                                    auth0Client?: { env?: { [key: string]: string }; name: string; version: string }
                                                                                                                                                                    Internal property to send information about the client to the authorization server.
                                                                                                                                                                    
+
                                                                                                                                                                    authorizationParams?: ClientAuthorizationParams
                                                                                                                                                                    URL parameters that will be sent back to the Authorization Server. This can be known parameters
+defined by Auth0 or custom parameters that you define.
                                                                                                                                                                    
+
                                                                                                                                                                    authorizeTimeoutInSeconds?: number
                                                                                                                                                                    A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout
+Defaults to 60s.
                                                                                                                                                                    
+
                                                                                                                                                                    cache?: ICache
                                                                                                                                                                    Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.
                                                                                                                                                                    
+
                                                                                                                                                                    cacheLocation?: CacheLocation
                                                                                                                                                                    The location to use when storing cache data. Valid values are memory or localstorage.
+The default setting is memory.
                                                                                                                                                                    
+
                                                                                                                                                                    Read more about changing storage options in the Auth0 docs
                                                                                                                                                                    
+
                                                                                                                                                                    clientId: string
                                                                                                                                                                    The Client ID found on your Application settings page
                                                                                                                                                                    
+
                                                                                                                                                                    cookieDomain?: string
                                                                                                                                                                    The domain the cookie is accessible from. If not set, the cookie is scoped to
+the current domain, including the subdomain.
                                                                                                                                                                    
+
                                                                                                                                                                    Note: setting this incorrectly may cause silent authentication to stop working
+on page load.
                                                                                                                                                                    
+
                                                                                                                                                                    To keep a user logged in across multiple subdomains set this to your
+top-level domain and prefixed with a . (eg: .example.com).
                                                                                                                                                                    
+
                                                                                                                                                                    domain: string
                                                                                                                                                                    Your Auth0 account domain such as 'example.auth0.com',
+'example.eu.auth0.com' or , 'example.mycompany.com'
+(when using custom domains)
                                                                                                                                                                    
+
                                                                                                                                                                    errorPath?: string
                                                                                                                                                                    Path in your application to redirect to when the Authorization server
+returns an error. Defaults to /
                                                                                                                                                                    
+
                                                                                                                                                                    httpInterceptor?: HttpInterceptorConfig
                                                                                                                                                                    Configuration for the built-in Http Interceptor, used for
+automatically attaching access tokens.
                                                                                                                                                                    
+
                                                                                                                                                                    httpTimeoutInSeconds?: number
                                                                                                                                                                    Specify the timeout for HTTP calls using fetch. The default is 10 seconds.
                                                                                                                                                                    
+
                                                                                                                                                                    interactiveErrorHandler?: "popup"
                                                                                                                                                                    Configures automatic handling of interactive authentication errors.
                                                                                                                                                                    
+
                                                                                                                                                                    When set, the SDK intercepts mfa_required errors from getTokenSilently()
+and handles them automatically instead of throwing to the caller.
                                                                                                                                                                    
+
                                                                                                                                                                      
+
                                                                                                                                                                    • 'popup': Opens Universal Login in a popup to complete MFA.
+The original authorizationParams (audience, scope) are preserved.
+On success, the token is returned. On failure, popup errors are thrown.
                                                                                                                                                                      • 
+
                                                                                                                                                                    
+
                                                                                                                                                                    This option only affects getTokenSilently(). Other methods are not affected.
                                                                                                                                                                    
+
                                                                                                                                                                    undefined (MFA errors are thrown to the caller)
 
                                                                                                                                                                    
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-              
                                                                                                                                                                    
-                issuer?:
-                string
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  The issuer to be used for validation of JWTs, optionally
-                  defaults to the domain above
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-              
                                                                                                                                                                    
-                leeway?:
-                number
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  The value in seconds used to account for clock skew in JWT
-                  expirations. Typically, this value is no more than a minute or
-                  two at maximum. Defaults to 60s.
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-              
                                                                                                                                                                    
-                legacySameSiteCookie?:
-                boolean
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Sets an additional cookie with no SameSite attribute to
-                  support legacy browsers that are not compatible with the
-                  latest SameSite changes. This will log a warning on modern
-                  browsers, you can disable the warning by setting this to false
-                  but be aware that some older useragents will not work, See
-                  https://www.chromium.org/updates/same-site/incompatible-clients
-                  Defaults to true
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-              
                                                                                                                                                                    
-                nowProvider?:
-                ()
-                =>
-                number
-                |
-                Promise<number>
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Modify the value used as the current time during the token
-                  validation.
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Note: Using this improperly can potentially
-                  compromise the token validation.
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-              
                                                                                                                                                                    
-                sessionCheckExpiryDays?:
-                number
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Number of days until the cookie
-                  auth0.is.authenticated will expire Defaults to 1.
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-              
                                                                                                                                                                    
-                sessionTransferTokenQueryParamName?:
-                string
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Query parameter name to extract the session transfer token
-                  from for Native to Web SSO.
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  When set, the SDK automatically extracts the token from the
-                  specified URL query parameter and includes it as
-                  session_transfer_token in authorization requests.
-                  This enables seamless single sign-on when users transition
-                  from a native mobile application to a web application.
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  After extraction, the token is automatically removed from the
-                  URL using window.history.replaceState() to
-                  prevent accidental reuse on subsequent authentication
-                  requests.
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Default: undefined (feature
-                  disabled)
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    Common values:
                                                                                                                                                                    
-                
                                                                                                                                                                      
-                  
                                                                                                                                                                    • 
-                    'session_transfer_token' - Standard parameter
-                    name
-                  
                                                                                                                                                                      • 
-                  
                                                                                                                                                                    • 'stt' - Shortened version
                                                                                                                                                                      • 
-                  
                                                                                                                                                                    • Custom parameter name of your choice
                                                                                                                                                                      • 
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Set to undefined to disable automatic extraction
-                  if you prefer to handle session transfer tokens manually.
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  
-                  
                                                                                                                                                                    const auth0 = await createAuth0Client({
                                                                                                                                                                      domain: '<AUTH0_DOMAIN>',
                                                                                                                                                                      clientId: '<AUTH0_CLIENT_ID>',
                                                                                                                                                                      sessionTransferTokenQueryParamName: 'session_transfer_token'
                                                                                                                                                                    });
+
+
                                                                                                                                                                    issuer?: string
                                                                                                                                                                    The issuer to be used for validation of JWTs, optionally defaults to the domain above
                                                                                                                                                                    
+
                                                                                                                                                                    leeway?: number
                                                                                                                                                                    The value in seconds used to account for clock skew in JWT expirations.
+Typically, this value is no more than a minute or two at maximum.
+Defaults to 60s.
                                                                                                                                                                    
+
                                                                                                                                                                    legacySameSiteCookie?: boolean
                                                                                                                                                                    Sets an additional cookie with no SameSite attribute to support legacy browsers
+that are not compatible with the latest SameSite changes.
+This will log a warning on modern browsers, you can disable the warning by setting
+this to false but be aware that some older useragents will not work,
+See https://www.chromium.org/updates/same-site/incompatible-clients
+Defaults to true
                                                                                                                                                                    
+
                                                                                                                                                                    nowProvider?: () => number | Promise<number>
                                                                                                                                                                    Modify the value used as the current time during the token validation.
                                                                                                                                                                    
+
                                                                                                                                                                    Note: Using this improperly can potentially compromise the token validation.
                                                                                                                                                                    
+
                                                                                                                                                                    sessionCheckExpiryDays?: number
                                                                                                                                                                    Number of days until the cookie auth0.is.authenticated will expire
+Defaults to 1.
                                                                                                                                                                    
+
                                                                                                                                                                    sessionTransferTokenQueryParamName?: string
                                                                                                                                                                    Query parameter name to extract the session transfer token from for Native to Web SSO.
                                                                                                                                                                    
+
                                                                                                                                                                    When set, the SDK automatically extracts the token from the specified URL query
+parameter and includes it as session_transfer_token in authorization requests.
+This enables seamless single sign-on when users transition from a native mobile
+application to a web application.
                                                                                                                                                                    
+
                                                                                                                                                                    After extraction, the token is automatically removed from the URL using
+window.history.replaceState() to prevent accidental reuse on subsequent
+authentication requests.
                                                                                                                                                                    
+
                                                                                                                                                                    Default: undefined (feature disabled)
                                                                                                                                                                    
+
                                                                                                                                                                    Common values:
                                                                                                                                                                    
+
                                                                                                                                                                      
+
                                                                                                                                                                    • 'session_transfer_token' - Standard parameter name
                                                                                                                                                                      • 
+
                                                                                                                                                                    • 'stt' - Shortened version
                                                                                                                                                                      • 
+
                                                                                                                                                                    • Custom parameter name of your choice
                                                                                                                                                                      • 
+
                                                                                                                                                                    
+
                                                                                                                                                                    Set to undefined to disable automatic extraction if you prefer to handle
+session transfer tokens manually.
                                                                                                                                                                    
+
                                                                                                                                                                    const auth0 = await createAuth0Client({
                                                                                                                                                                      domain: '<AUTH0_DOMAIN>',
                                                                                                                                                                      clientId: '<AUTH0_CLIENT_ID>',
                                                                                                                                                                      sessionTransferTokenQueryParamName: 'session_transfer_token'
                                                                                                                                                                    });
 
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  
-                  
                                                                                                                                                                    
-                    https://auth0.com/docs/authenticate/single-sign-on/native-to-web
-                  
                                                                                                                                                                    
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-              
                                                                                                                                                                    
-                skipRedirectCallback?:
-                boolean
-              
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  By default, if the page URL has code and state parameters, the
-                  SDK will assume they are for an Auth0 application and attempt
-                  to exchange the code for a token. In some cases the code might
-                  be for something else (e.g. another OAuth SDK). In these
-                  instances you can instruct the client to ignore them by
-                  setting skipRedirectCallback.
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    AuthModule.forRoot({
                                                                                                                                                                      skipRedirectCallback: window.location.pathname === '/other-callback'
                                                                                                                                                                    })
+
+
                                                                                                                                                                    https://auth0.com/docs/authenticate/single-sign-on/native-to-web
                                                                                                                                                                    
+
                                                                                                                                                                    skipRedirectCallback?: boolean

                                                                                                                                                                    By default, if the page URL has code and state parameters, the SDK will assume they are for +an Auth0 application and attempt to exchange the code for a token. +In some cases the code might be for something else (e.g. another OAuth SDK). In these +instances you can instruct the client to ignore them by setting skipRedirectCallback.

                                                                                                                                                                    +
                                                                                                                                                                    AuthModule.forRoot({
                                                                                                                                                                      skipRedirectCallback: window.location.pathname === '/other-callback'
                                                                                                                                                                    })
                                                                                                                                                                    -

                                                                                                                                                                    - Note: In the above example, - /other-callback is an existing route that will be - called by any other OAuth provider with a - code (or error in case when - something went wrong) and state. -

                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - useCookiesForTransactions?: - boolean -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    - If true, the SDK will use a cookie when storing - information about the auth transaction while the user is going - through the authentication flow on the authorization server. -

                                                                                                                                                                    -

                                                                                                                                                                    - The default is false, in which case the SDK will - use session storage. -

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -

                                                                                                                                                                    - You might want to enable this if you rely on your users - being able to authenticate using flows that may end up - spanning across multiple tabs (e.g. magic links) or you - cannot otherwise rely on session storage being available. -

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - useDpop?: - boolean -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    - If true, DPoP (OAuth 2.0 Demonstrating Proof of - Possession, RFC9449) will be used to cryptographically bind - tokens to this specific browser so they can't be used from a - different device in case of a leak. -

                                                                                                                                                                    -

                                                                                                                                                                    The default setting is false.

                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - useFormData?: - boolean -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    - If true, data to the token endpoint is transmitted as - x-www-form-urlencoded data, if false it will be transmitted as - JSON. The default setting is true. -

                                                                                                                                                                    -

                                                                                                                                                                    - Note: Setting this to false may - affect you if you use Auth0 Rules and are sending custom, - non-primitive data. If you disable this, please verify that - your Auth0 Rules continue to work as intended. -

                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - useMrrt?: - boolean -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    - If true, the SDK will allow the refreshing of - tokens using MRRT -

                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - useRefreshTokens?: - boolean -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    - If true, refresh tokens are used to fetch new access tokens - from the Auth0 server. If false, the standard technique of - using a hidden iframe and the - authorization_code grant with - prompt=none is used. The default setting is - false. -

                                                                                                                                                                    -

                                                                                                                                                                    - Standard technique relies on cookies. Because browsers - increasingly block third-party cookies, it requires a Custom - Domain to function reliably. Refresh tokens serve as a - fallback for environments where third-party cookies are - blocked. Using a Custom Domain with this set to - false is the most secure and recommended - approach. -

                                                                                                                                                                    -

                                                                                                                                                                    - Note: Use of refresh tokens must be enabled - by an administrator on your Auth0 client application. -

                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - useRefreshTokensFallback?: - boolean -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    - If true, fallback to the technique of using a hidden iframe - and the authorization_code grant with - prompt=none when unable to use refresh tokens. If - false, the iframe fallback is not used and errors relating to - a failed refresh_token grant should be handled - appropriately. The default setting is false. -

                                                                                                                                                                    -

                                                                                                                                                                    - Note: There might be situations where doing - silent auth with a Web Message response from an iframe is not - possible, like when you're serving your application from the - file system or a custom protocol (like in a Desktop or Native - app). In situations like this you can disable the iframe - fallback and handle the failed - refresh_token grant and prompt the user to login - interactively with loginWithRedirect or - loginWithPopup." -

                                                                                                                                                                    -

                                                                                                                                                                    - E.g. Using the file: protocol in an Electron - application does not support that legacy technique. -

                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - 
                                                                                                                                                                    let token: string;
                                                                                                                                                                    try {
                                                                                                                                                                      token = await auth0.getTokenSilently();
                                                                                                                                                                    } catch (e) {
                                                                                                                                                                      if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
                                                                                                                                                                        auth0.loginWithRedirect();
                                                                                                                                                                      }
                                                                                                                                                                    }
+
                                                                                                                                                                    Note: In the above example, /other-callback is an existing route that will be called
+by any other OAuth provider with a code (or error in case when something went wrong) and state.
                                                                                                                                                                    
+
                                                                                                                                                                    useCookiesForTransactions?: boolean

                                                                                                                                                                    If true, the SDK will use a cookie when storing information about the auth transaction while +the user is going through the authentication flow on the authorization server.

                                                                                                                                                                    +

                                                                                                                                                                    The default is false, in which case the SDK will use session storage.

                                                                                                                                                                    +

                                                                                                                                                                    You might want to enable this if you rely on your users being able to authenticate using flows that +may end up spanning across multiple tabs (e.g. magic links) or you cannot otherwise rely on session storage being available.

                                                                                                                                                                    +
                                                                                                                                                                    useDpop?: boolean

                                                                                                                                                                    If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449) +will be used to cryptographically bind tokens to this specific browser +so they can't be used from a different device in case of a leak.

                                                                                                                                                                    +

                                                                                                                                                                    The default setting is false.

                                                                                                                                                                    +
                                                                                                                                                                    useFormData?: boolean

                                                                                                                                                                    If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.

                                                                                                                                                                    +

                                                                                                                                                                    Note: Setting this to false may affect you if you use Auth0 Rules and are sending custom, non-primitive data. If you disable this, +please verify that your Auth0 Rules continue to work as intended.

                                                                                                                                                                    +
                                                                                                                                                                    useMrrt?: boolean

                                                                                                                                                                    If true, the SDK will allow the refreshing of tokens using MRRT

                                                                                                                                                                    +
                                                                                                                                                                    useRefreshTokens?: boolean

                                                                                                                                                                    If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the standard technique of using a hidden iframe and the authorization_code grant with prompt=none is used. +The default setting is false.

                                                                                                                                                                    +

                                                                                                                                                                    Standard technique relies on cookies. Because browsers increasingly block third-party cookies, it requires a Custom Domain to function reliably. Refresh tokens serve as a fallback for environments where third-party cookies are blocked. +Using a Custom Domain with this set to false is the most secure and recommended approach.

                                                                                                                                                                    +

                                                                                                                                                                    Note: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.

                                                                                                                                                                    +
                                                                                                                                                                    useRefreshTokensFallback?: boolean

                                                                                                                                                                    If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and +errors relating to a failed refresh_token grant should be handled appropriately. The default setting is false.

                                                                                                                                                                    +

                                                                                                                                                                    Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, +like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). +In situations like this you can disable the iframe fallback and handle the failed refresh_token grant and prompt the user to login interactively with loginWithRedirect or loginWithPopup."

                                                                                                                                                                    +

                                                                                                                                                                    E.g. Using the file: protocol in an Electron application does not support that legacy technique.

                                                                                                                                                                    +
                                                                                                                                                                    let token: string;
                                                                                                                                                                    try {
                                                                                                                                                                      token = await auth0.getTokenSilently();
                                                                                                                                                                    } catch (e) {
                                                                                                                                                                      if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
                                                                                                                                                                        auth0.loginWithRedirect();
                                                                                                                                                                      }
                                                                                                                                                                    }
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    - workerUrl?: - string -
                                                                                                                                                                    -
                                                                                                                                                                    -

                                                                                                                                                                    - If provided, the SDK will load the token worker from this URL - instead of the integrated blob. An example of - when this is useful is if you have strict - Content-Security-Policy (CSP) and wish to avoid needing to set - worker-src: blob:. We recommend either serving - the worker, which you can find in the module at - <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 - CDN - https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js. -

                                                                                                                                                                    -

                                                                                                                                                                    - Note: The worker is only used when - useRefreshTokens: true, - cacheLocation: 'memory', and the - cache is not custom. -

                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - -

                                                                                                                                                                    Settings

                                                                                                                                                                    -                                                                                                                                                                     -
                                                                                                                                                                    -
                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                      -
                                                                                                                                                                    • - -
                                                                                                                                                                      • -
                                                                                                                                                                    • - -
                                                                                                                                                                      • -
                                                                                                                                                                    • - -
                                                                                                                                                                      • -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - -

                                                                                                                                                                    On This Page

                                                                                                                                                                    -                                                                                                                                                                     -
                                                                                                                                                                    -
                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - + +
                                                                                                                                                                    workerUrl?: string

                                                                                                                                                                    If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict +Content-Security-Policy (CSP) and wish to avoid needing to set worker-src: blob:. We recommend either serving the worker, which you can find in the module +at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN +https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.

                                                                                                                                                                    +

                                                                                                                                                                    Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.

                                                                                                                                                                    +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    On This Page

                                                                                                                                                                    Properties
                                                                                                                                                                    diff --git a/docs/interfaces/Authenticator.html b/docs/interfaces/Authenticator.html index 02d8ad2b..8bec6a3e 100644 --- a/docs/interfaces/Authenticator.html +++ b/docs/interfaces/Authenticator.html @@ -1,692 +1,16 @@ - - - - - - Authenticator | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      Preparing search index...
                                                                                                                                                                      -
                                                                                                                                                                      -                                                                                                                                                                       - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -

                                                                                                                                                                      Interface Authenticator

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Represents an MFA authenticator enrolled by a user

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - interface - Authenticator - {
                                                                                                                                                                          active: - boolean;
                                                                                                                                                                          authenticatorType: - AuthenticatorType;
                                                                                                                                                                          createdAt?: - string;
                                                                                                                                                                          id: - string;
                                                                                                                                                                          lastAuth?: - string;
                                                                                                                                                                          name?: - string;
                                                                                                                                                                          type?: - string;
                                                                                                                                                                      } -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      Index
                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Properties

                                                                                                                                                                      -
                                                                                                                                                                      - - active - - authenticatorType - - createdAt? - - id - - lastAuth? - - name? - - type? -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - -

                                                                                                                                                                      Properties

                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - active: - boolean -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Whether the authenticator is active

                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - authenticatorType: - AuthenticatorType -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Type of authenticator

                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - createdAt?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      ISO 8601 timestamp when created

                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - id: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Unique identifier for the authenticator

                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - lastAuth?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      ISO 8601 timestamp of last authentication

                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - name?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Optional friendly name

                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - type?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Types of MFA challenges

                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - -

                                                                                                                                                                      Settings

                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -
                                                                                                                                                                      - Member Visibility -
                                                                                                                                                                        -
                                                                                                                                                                      • - -
                                                                                                                                                                        • -
                                                                                                                                                                      • - -
                                                                                                                                                                        • -
                                                                                                                                                                      • - -
                                                                                                                                                                        • -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - -

                                                                                                                                                                      On This Page

                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -
                                                                                                                                                                      - - Properties - - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - +Authenticator | @auth0/auth0-angular
                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface Authenticator

                                                                                                                                                                        Represents an MFA authenticator enrolled by a user

                                                                                                                                                                        +
                                                                                                                                                                        interface Authenticator {
                                                                                                                                                                            active: boolean;
                                                                                                                                                                            authenticatorType: AuthenticatorType;
                                                                                                                                                                            createdAt?: string;
                                                                                                                                                                            id: string;
                                                                                                                                                                            lastAuth?: string;
                                                                                                                                                                            name?: string;
                                                                                                                                                                            type?: string;
                                                                                                                                                                        }
                                                                                                                                                                        Index

                                                                                                                                                                        Properties

                                                                                                                                                                        active +authenticatorType +createdAt? +id +lastAuth? +name? +type? +

                                                                                                                                                                        Properties

                                                                                                                                                                        active: boolean

                                                                                                                                                                        Whether the authenticator is active

                                                                                                                                                                        +
                                                                                                                                                                        authenticatorType: AuthenticatorType

                                                                                                                                                                        Type of authenticator

                                                                                                                                                                        +
                                                                                                                                                                        createdAt?: string

                                                                                                                                                                        ISO 8601 timestamp when created

                                                                                                                                                                        +
                                                                                                                                                                        id: string

                                                                                                                                                                        Unique identifier for the authenticator

                                                                                                                                                                        +
                                                                                                                                                                        lastAuth?: string

                                                                                                                                                                        ISO 8601 timestamp of last authentication

                                                                                                                                                                        +
                                                                                                                                                                        name?: string

                                                                                                                                                                        Optional friendly name

                                                                                                                                                                        +
                                                                                                                                                                        type?: string

                                                                                                                                                                        Types of MFA challenges

                                                                                                                                                                        +

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility

                                                                                                                                                                        On This Page

                                                                                                                                                                        Properties
                                                                                                                                                                        diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 8255eb44..ec8d0c55 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,1289 +1,70 @@ - - - - - - AuthorizationParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          Preparing search index...
                                                                                                                                                                          -
                                                                                                                                                                          -                                                                                                                                                                           - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -

                                                                                                                                                                          Interface AuthorizationParams

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - interface - AuthorizationParams - {
                                                                                                                                                                              acr_values?: - string;
                                                                                                                                                                              audience?: - string;
                                                                                                                                                                              connection?: - string;
                                                                                                                                                                              display?: - "page" - | - "popup" - | - "touch" - | - "wap";
                                                                                                                                                                              id_token_hint?: - string;
                                                                                                                                                                              invitation?: - string;
                                                                                                                                                                              login_hint?: - string;
                                                                                                                                                                              max_age?: - string - | - number;
                                                                                                                                                                              organization?: - string;
                                                                                                                                                                              prompt?: - "none" - | - "login" - | - "consent" - | - "select_account";
                                                                                                                                                                              redirect_uri?: - string;
                                                                                                                                                                              scope?: - string;
                                                                                                                                                                              screen_hint?: - string;
                                                                                                                                                                              session_transfer_token?: - string;
                                                                                                                                                                              ui_locales?: - string;
                                                                                                                                                                              [key: - string]: - any;
                                                                                                                                                                          } -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Indexable

                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • -
                                                                                                                                                                            - [key: - string]: - any -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            - If you need to send custom parameters to the Authorization - Server, make sure to use the original parameter name. -

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -
                                                                                                                                                                          Index
                                                                                                                                                                          -                                                                                                                                                                           -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Properties

                                                                                                                                                                          -
                                                                                                                                                                          - - acr_values? - - audience? - - connection? - - display? - - id_token_hint? - - invitation? - - login_hint? - - max_age? - - organization? - - prompt? - - redirect_uri? - - scope? - - screen_hint? - - session_transfer_token? - - ui_locales? -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -

                                                                                                                                                                          Properties

                                                                                                                                                                          -                                                                                                                                                                           -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - acr_values?: - string -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - audience?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The default audience to be used for requesting API access. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - connection?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The name of the connection configured for your application. If - null, it will redirect to the Auth0 Login Page and show the - Login Widget. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - display?: - "page" - | - "popup" - | - "touch" - | - "wap" -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • - 'page': displays the UI with a full page view -
                                                                                                                                                                            • -
                                                                                                                                                                          • - 'popup': displays the UI with a popup window -
                                                                                                                                                                            • -
                                                                                                                                                                          • - 'touch': displays the UI in a way that - leverages a touch interface -
                                                                                                                                                                            • -
                                                                                                                                                                          • - 'wap': displays the UI with a "feature - phone" type interface -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - id_token_hint?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          Previously issued ID Token.

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - invitation?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The Id of an invitation to accept. This is available from the - user invitation URL that is given when participating in a user - invitation flow. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - login_hint?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The user's email address or other identifier. When your app - knows which user is trying to authenticate, you can provide - this parameter to pre-fill the email box or select the right - session for sign-in. -

                                                                                                                                                                          -

                                                                                                                                                                          This currently only affects the classic Lock experience.

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - max_age?: - string - | - number -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - Maximum allowable elapsed time (in seconds) since - authentication. If the last time the user authenticated is - greater than this value, the user must be reauthenticated. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - organization?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          The organization to log in to.

                                                                                                                                                                          -

                                                                                                                                                                          - This will specify an organization parameter in - your user's login request. -

                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • - If you provide an Organization ID (a string with the prefix - org_), it will be validated against the - org_id claim of your user's ID Token. The - validation is case-sensitive. -
                                                                                                                                                                            • -
                                                                                                                                                                          • - If you provide an Organization Name (a string - without the prefix org_), it will be - validated against the org_name claim of your - user's ID Token. The validation is case-insensitive. To use - an Organization Name you must have "Allow Organization - Names in Authentication API" switched on in your Auth0 - settings dashboard. More information is available on the - Auth0 documentation portal -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - prompt?: - "none" - | - "login" - | - "consent" - | - "select_account" -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                            -
                                                                                                                                                                          • - 'none': do not prompt user for login or consent - on reauthentication -
                                                                                                                                                                            • -
                                                                                                                                                                          • - 'login': prompt user for reauthentication -
                                                                                                                                                                            • -
                                                                                                                                                                          • - 'consent': prompt user for consent before - processing request -
                                                                                                                                                                            • -
                                                                                                                                                                          • - 'select_account': prompt user to select an - account -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - redirect_uri?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The default URL where Auth0 will redirect your browser to with - the authentication result. It must be whitelisted in the - "Allowed Callback URLs" field in your Auth0 - Application's settings. If not provided here, it should be - provided in the other methods that provide authentication. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - scope?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          The default scope to be used on authentication requests.

                                                                                                                                                                          -

                                                                                                                                                                          - This defaults to profile email if not set. If you - are setting extra scopes and require profile and - email to be included then you must include them - in the provided scope. -

                                                                                                                                                                          -

                                                                                                                                                                          - Note: The openid scope is - always applied regardless of this setting. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - screen_hint?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - Provides a hint to Auth0 as to what flow should be displayed. - The default behavior is to show a login page but you can - override this by passing 'signup' to show the signup page - instead. -

                                                                                                                                                                          -

                                                                                                                                                                          This only affects the New Universal Login Experience.

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - session_transfer_token?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - Session transfer token from a native application for Native to - Web SSO. When - sessionTransferTokenQueryParamName is set, this - is automatically extracted from the specified URL query - parameter if present. -

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -

                                                                                                                                                                          - https://auth0.com/docs/authenticate/single-sign-on/native-to-web -

                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          - ui_locales?: - string -
                                                                                                                                                                          -
                                                                                                                                                                          -

                                                                                                                                                                          - The space-separated list of language tags, ordered by - preference. For example: 'fr-CA fr en'. -

                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -

                                                                                                                                                                          Settings

                                                                                                                                                                          -                                                                                                                                                                           -
                                                                                                                                                                          -
                                                                                                                                                                          - Member Visibility -
                                                                                                                                                                            -
                                                                                                                                                                          • - -
                                                                                                                                                                            • -
                                                                                                                                                                          • - -
                                                                                                                                                                            • -
                                                                                                                                                                          • - -
                                                                                                                                                                            • -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - -

                                                                                                                                                                          On This Page

                                                                                                                                                                          -                                                                                                                                                                           -
                                                                                                                                                                          -
                                                                                                                                                                          - - Properties - - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          - - +AuthorizationParams | @auth0/auth0-angular
                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface AuthorizationParams

                                                                                                                                                                            interface AuthorizationParams {
                                                                                                                                                                                acr_values?: string;
                                                                                                                                                                                audience?: string;
                                                                                                                                                                                connection?: string;
                                                                                                                                                                                display?: "page" | "popup" | "touch" | "wap";
                                                                                                                                                                                id_token_hint?: string;
                                                                                                                                                                                invitation?: string;
                                                                                                                                                                                login_hint?: string;
                                                                                                                                                                                max_age?: string | number;
                                                                                                                                                                                organization?: string;
                                                                                                                                                                                prompt?: "none" | "login" | "consent" | "select_account";
                                                                                                                                                                                redirect_uri?: string;
                                                                                                                                                                                scope?: string;
                                                                                                                                                                                screen_hint?: string;
                                                                                                                                                                                session_transfer_token?: string;
                                                                                                                                                                                ui_locales?: string;
                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                            }

                                                                                                                                                                            Indexable

                                                                                                                                                                            • [key: string]: any

                                                                                                                                                                              If you need to send custom parameters to the Authorization Server, +make sure to use the original parameter name.

                                                                                                                                                                              +
                                                                                                                                                                            Index

                                                                                                                                                                            Properties

                                                                                                                                                                            acr_values? +audience? +connection? +display? +id_token_hint? +invitation? +login_hint? +max_age? +organization? +prompt? +redirect_uri? +scope? +screen_hint? +session_transfer_token? +ui_locales? +

                                                                                                                                                                            Properties

                                                                                                                                                                            acr_values?: string
                                                                                                                                                                            audience?: string

                                                                                                                                                                            The default audience to be used for requesting API access.

                                                                                                                                                                            +
                                                                                                                                                                            connection?: string

                                                                                                                                                                            The name of the connection configured for your application. +If null, it will redirect to the Auth0 Login Page and show +the Login Widget.

                                                                                                                                                                            +
                                                                                                                                                                            display?: "page" | "popup" | "touch" | "wap"
                                                                                                                                                                              +
                                                                                                                                                                            • 'page': displays the UI with a full page view
                                                                                                                                                                              • +
                                                                                                                                                                            • 'popup': displays the UI with a popup window
                                                                                                                                                                              • +
                                                                                                                                                                            • 'touch': displays the UI in a way that leverages a touch interface
                                                                                                                                                                              • +
                                                                                                                                                                            • 'wap': displays the UI with a "feature phone" type interface
                                                                                                                                                                              • +
                                                                                                                                                                            +
                                                                                                                                                                            id_token_hint?: string

                                                                                                                                                                            Previously issued ID Token.

                                                                                                                                                                            +
                                                                                                                                                                            invitation?: string

                                                                                                                                                                            The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

                                                                                                                                                                            +
                                                                                                                                                                            login_hint?: string

                                                                                                                                                                            The user's email address or other identifier. When your app knows +which user is trying to authenticate, you can provide this parameter +to pre-fill the email box or select the right session for sign-in.

                                                                                                                                                                            +

                                                                                                                                                                            This currently only affects the classic Lock experience.

                                                                                                                                                                            +
                                                                                                                                                                            max_age?: string | number

                                                                                                                                                                            Maximum allowable elapsed time (in seconds) since authentication. +If the last time the user authenticated is greater than this value, +the user must be reauthenticated.

                                                                                                                                                                            +
                                                                                                                                                                            organization?: string

                                                                                                                                                                            The organization to log in to.

                                                                                                                                                                            +

                                                                                                                                                                            This will specify an organization parameter in your user's login request.

                                                                                                                                                                            +
                                                                                                                                                                              +
                                                                                                                                                                            • If you provide an Organization ID (a string with the prefix org_), it will be validated against the org_id claim of your user's ID Token. The validation is case-sensitive.
                                                                                                                                                                              • +
                                                                                                                                                                            • If you provide an Organization Name (a string without the prefix org_), it will be validated against the org_name claim of your user's ID Token. The validation is case-insensitive. +To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard. +More information is available on the Auth0 documentation portal
                                                                                                                                                                              • +
                                                                                                                                                                            +
                                                                                                                                                                            prompt?: "none" | "login" | "consent" | "select_account"
                                                                                                                                                                              +
                                                                                                                                                                            • 'none': do not prompt user for login or consent on reauthentication
                                                                                                                                                                              • +
                                                                                                                                                                            • 'login': prompt user for reauthentication
                                                                                                                                                                              • +
                                                                                                                                                                            • 'consent': prompt user for consent before processing request
                                                                                                                                                                              • +
                                                                                                                                                                            • 'select_account': prompt user to select an account
                                                                                                                                                                              • +
                                                                                                                                                                            +
                                                                                                                                                                            redirect_uri?: string

                                                                                                                                                                            The default URL where Auth0 will redirect your browser to with +the authentication result. It must be whitelisted in +the "Allowed Callback URLs" field in your Auth0 Application's +settings. If not provided here, it should be provided in the other +methods that provide authentication.

                                                                                                                                                                            +
                                                                                                                                                                            scope?: string

                                                                                                                                                                            The default scope to be used on authentication requests.

                                                                                                                                                                            +

                                                                                                                                                                            This defaults to profile email if not set. If you are setting extra scopes and require +profile and email to be included then you must include them in the provided scope.

                                                                                                                                                                            +

                                                                                                                                                                            Note: The openid scope is always applied regardless of this setting.

                                                                                                                                                                            +
                                                                                                                                                                            screen_hint?: string

                                                                                                                                                                            Provides a hint to Auth0 as to what flow should be displayed. +The default behavior is to show a login page but you can override +this by passing 'signup' to show the signup page instead.

                                                                                                                                                                            +

                                                                                                                                                                            This only affects the New Universal Login Experience.

                                                                                                                                                                            +
                                                                                                                                                                            session_transfer_token?: string

                                                                                                                                                                            Session transfer token from a native application for Native to Web SSO. +When sessionTransferTokenQueryParamName is set, this is automatically +extracted from the specified URL query parameter if present.

                                                                                                                                                                            +

                                                                                                                                                                            https://auth0.com/docs/authenticate/single-sign-on/native-to-web

                                                                                                                                                                            +
                                                                                                                                                                            ui_locales?: string

                                                                                                                                                                            The space-separated list of language tags, ordered by preference. +For example: 'fr-CA fr en'.

                                                                                                                                                                            +

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            On This Page

                                                                                                                                                                            Properties
                                                                                                                                                                            diff --git a/docs/interfaces/ChallengeAuthenticatorParams.html b/docs/interfaces/ChallengeAuthenticatorParams.html index 9df88c6e..cf0226d9 100644 --- a/docs/interfaces/ChallengeAuthenticatorParams.html +++ b/docs/interfaces/ChallengeAuthenticatorParams.html @@ -1,500 +1,8 @@ - - - - - - ChallengeAuthenticatorParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                            -
                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              Preparing search index...
                                                                                                                                                                              -
                                                                                                                                                                              -                                                                                                                                                                               - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -

                                                                                                                                                                              Interface ChallengeAuthenticatorParams

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Parameters for initiating an MFA challenge

                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - interface - ChallengeAuthenticatorParams - {
                                                                                                                                                                                  authenticatorId?: - string;
                                                                                                                                                                                  challengeType: - "otp" - | - "oob";
                                                                                                                                                                                  mfaToken: - string;
                                                                                                                                                                              } -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - -
                                                                                                                                                                              Index
                                                                                                                                                                              -                                                                                                                                                                               -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Properties

                                                                                                                                                                              -
                                                                                                                                                                              - - authenticatorId? - - challengeType - - mfaToken -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - -

                                                                                                                                                                              Properties

                                                                                                                                                                              -                                                                                                                                                                               -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - authenticatorId?: - string -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Specific authenticator to challenge (optional)

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - challengeType: - "otp" - | - "oob" -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              Type of challenge to initiate

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              - mfaToken: - string -
                                                                                                                                                                              -
                                                                                                                                                                              -

                                                                                                                                                                              - MFA token from mfa_required error or MFA-scoped access token -

                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - -

                                                                                                                                                                              Settings

                                                                                                                                                                              -                                                                                                                                                                               -
                                                                                                                                                                              -
                                                                                                                                                                              - Member Visibility -
                                                                                                                                                                                -
                                                                                                                                                                              • - -
                                                                                                                                                                                • -
                                                                                                                                                                              • - -
                                                                                                                                                                                • -
                                                                                                                                                                              • - -
                                                                                                                                                                                • -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - -

                                                                                                                                                                              On This Page

                                                                                                                                                                              -                                                                                                                                                                               -
                                                                                                                                                                              -
                                                                                                                                                                              - - Properties - - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              -
                                                                                                                                                                              - - +ChallengeAuthenticatorParams | @auth0/auth0-angular
                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Interface ChallengeAuthenticatorParams

                                                                                                                                                                                Parameters for initiating an MFA challenge

                                                                                                                                                                                +
                                                                                                                                                                                interface ChallengeAuthenticatorParams {
                                                                                                                                                                                    authenticatorId?: string;
                                                                                                                                                                                    challengeType: "otp" | "oob";
                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                }
                                                                                                                                                                                Index

                                                                                                                                                                                Properties

                                                                                                                                                                                authenticatorId? +challengeType +mfaToken +

                                                                                                                                                                                Properties

                                                                                                                                                                                authenticatorId?: string

                                                                                                                                                                                Specific authenticator to challenge (optional)

                                                                                                                                                                                +
                                                                                                                                                                                challengeType: "otp" | "oob"

                                                                                                                                                                                Type of challenge to initiate

                                                                                                                                                                                +
                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                MFA token from mfa_required error or MFA-scoped access token

                                                                                                                                                                                +

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility

                                                                                                                                                                                On This Page

                                                                                                                                                                                Properties
                                                                                                                                                                                diff --git a/docs/interfaces/ChallengeResponse.html b/docs/interfaces/ChallengeResponse.html index 56d61882..3e118afe 100644 --- a/docs/interfaces/ChallengeResponse.html +++ b/docs/interfaces/ChallengeResponse.html @@ -1,496 +1,8 @@ - - - - - - ChallengeResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                -
                                                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                  -
                                                                                                                                                                                  -                                                                                                                                                                                   - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -

                                                                                                                                                                                  Interface ChallengeResponse

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Response from initiating an MFA challenge

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - interface - ChallengeResponse - {
                                                                                                                                                                                      bindingMethod?: - string;
                                                                                                                                                                                      challengeType: - "otp" - | - "oob";
                                                                                                                                                                                      oobCode?: - string;
                                                                                                                                                                                  } -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -
                                                                                                                                                                                  Index
                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Properties

                                                                                                                                                                                  -
                                                                                                                                                                                  - - bindingMethod? - - challengeType - - oobCode? -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  Properties

                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - bindingMethod?: - string -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Binding method for OOB (e.g., 'prompt')

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - challengeType: - "otp" - | - "oob" -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Type of challenge created

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  - oobCode?: - string -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  Out-of-band code (for OOB challenges)

                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  Settings

                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  - Member Visibility -
                                                                                                                                                                                    -
                                                                                                                                                                                  • - -
                                                                                                                                                                                    • -
                                                                                                                                                                                  • - -
                                                                                                                                                                                    • -
                                                                                                                                                                                  • - -
                                                                                                                                                                                    • -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Properties - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - +ChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface ChallengeResponse

                                                                                                                                                                                    Response from initiating an MFA challenge

                                                                                                                                                                                    +
                                                                                                                                                                                    interface ChallengeResponse {
                                                                                                                                                                                        bindingMethod?: string;
                                                                                                                                                                                        challengeType: "otp" | "oob";
                                                                                                                                                                                        oobCode?: string;
                                                                                                                                                                                    }
                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    bindingMethod? +challengeType +oobCode? +

                                                                                                                                                                                    Properties

                                                                                                                                                                                    bindingMethod?: string

                                                                                                                                                                                    Binding method for OOB (e.g., 'prompt')

                                                                                                                                                                                    +
                                                                                                                                                                                    challengeType: "otp" | "oob"

                                                                                                                                                                                    Type of challenge created

                                                                                                                                                                                    +
                                                                                                                                                                                    oobCode?: string

                                                                                                                                                                                    Out-of-band code (for OOB challenges)

                                                                                                                                                                                    +

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                    On This Page

                                                                                                                                                                                    Properties
                                                                                                                                                                                    diff --git a/docs/interfaces/EmailAuthenticationMethod.html b/docs/interfaces/EmailAuthenticationMethod.html new file mode 100644 index 00000000..9573a78a --- /dev/null +++ b/docs/interfaces/EmailAuthenticationMethod.html @@ -0,0 +1,9 @@ +EmailAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Interface EmailAuthenticationMethod

                                                                                                                                                                                      interface EmailAuthenticationMethod {
                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                          email: string;
                                                                                                                                                                                          id: string;
                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                          name?: string;
                                                                                                                                                                                          type: "email";
                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                      }

                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                      • AuthenticationMethodWithMetadata
                                                                                                                                                                                        • EmailAuthenticationMethod
                                                                                                                                                                                      Index

                                                                                                                                                                                      Properties

                                                                                                                                                                                      confirmed +created_at +email +id +last_auth_at? +name? +type +usage +

                                                                                                                                                                                      Properties

                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                      created_at: string
                                                                                                                                                                                      email: string
                                                                                                                                                                                      id: string
                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                      name?: string
                                                                                                                                                                                      type: "email"
                                                                                                                                                                                      usage: ("primary" | "secondary")[]

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Properties
                                                                                                                                                                                      diff --git a/docs/interfaces/EmailEnrollmentChallengeOptions.html b/docs/interfaces/EmailEnrollmentChallengeOptions.html new file mode 100644 index 00000000..721d9671 --- /dev/null +++ b/docs/interfaces/EmailEnrollmentChallengeOptions.html @@ -0,0 +1,3 @@ +EmailEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Interface EmailEnrollmentChallengeOptions

                                                                                                                                                                                        interface EmailEnrollmentChallengeOptions {
                                                                                                                                                                                            email: string;
                                                                                                                                                                                            type: "email";
                                                                                                                                                                                        }
                                                                                                                                                                                        Index

                                                                                                                                                                                        Properties

                                                                                                                                                                                        email +type +

                                                                                                                                                                                        Properties

                                                                                                                                                                                        email: string
                                                                                                                                                                                        type: "email"

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                        On This Page

                                                                                                                                                                                        Properties
                                                                                                                                                                                        diff --git a/docs/interfaces/EmailEnrollmentChallengeResponse.html b/docs/interfaces/EmailEnrollmentChallengeResponse.html new file mode 100644 index 00000000..934cc08f --- /dev/null +++ b/docs/interfaces/EmailEnrollmentChallengeResponse.html @@ -0,0 +1,5 @@ +EmailEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Interface EmailEnrollmentChallengeResponse

                                                                                                                                                                                          interface EmailEnrollmentChallengeResponse {
                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                              id: string;
                                                                                                                                                                                              location: string;
                                                                                                                                                                                              type: "email";
                                                                                                                                                                                          }

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          • EnrollmentChallengeBaseResponse
                                                                                                                                                                                            • EmailEnrollmentChallengeResponse
                                                                                                                                                                                          Index

                                                                                                                                                                                          Properties

                                                                                                                                                                                          auth_session +id +location +type +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                          id: string
                                                                                                                                                                                          location: string
                                                                                                                                                                                          type: "email"

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          Properties
                                                                                                                                                                                          diff --git a/docs/interfaces/EmailEnrollmentVerifyOptions.html b/docs/interfaces/EmailEnrollmentVerifyOptions.html new file mode 100644 index 00000000..ca2abc90 --- /dev/null +++ b/docs/interfaces/EmailEnrollmentVerifyOptions.html @@ -0,0 +1,5 @@ +EmailEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface EmailEnrollmentVerifyOptions

                                                                                                                                                                                            interface EmailEnrollmentVerifyOptions {
                                                                                                                                                                                                auth_session: string;
                                                                                                                                                                                                location: string;
                                                                                                                                                                                                otp_code: string;
                                                                                                                                                                                                type: "email";
                                                                                                                                                                                            }

                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                            • EnrollmentVerifyBaseOptions
                                                                                                                                                                                              • EmailEnrollmentVerifyOptions
                                                                                                                                                                                            Index

                                                                                                                                                                                            Properties

                                                                                                                                                                                            auth_session +location +otp_code +type +

                                                                                                                                                                                            Properties

                                                                                                                                                                                            auth_session: string
                                                                                                                                                                                            location: string
                                                                                                                                                                                            otp_code: string
                                                                                                                                                                                            type: "email"

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            On This Page

                                                                                                                                                                                            Properties
                                                                                                                                                                                            diff --git a/docs/interfaces/EnrollEmailParams.html b/docs/interfaces/EnrollEmailParams.html index ff51d4a7..102cfe6b 100644 --- a/docs/interfaces/EnrollEmailParams.html +++ b/docs/interfaces/EnrollEmailParams.html @@ -1,504 +1,8 @@ - - - - - - EnrollEmailParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              -
                                                                                                                                                                                              -                                                                                                                                                                                               - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -

                                                                                                                                                                                              Interface EnrollEmailParams

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Email enrollment parameters

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - interface - EnrollEmailParams - {
                                                                                                                                                                                                  email?: - string;
                                                                                                                                                                                                  factorType: - "email";
                                                                                                                                                                                                  mfaToken: - string;
                                                                                                                                                                                              } -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                              -
                                                                                                                                                                                                -
                                                                                                                                                                                              • - EnrollBaseParams -
                                                                                                                                                                                                  -
                                                                                                                                                                                                • - EnrollEmailParams -
                                                                                                                                                                                                  • -
                                                                                                                                                                                                -
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -
                                                                                                                                                                                              Index
                                                                                                                                                                                              -                                                                                                                                                                                               -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              -
                                                                                                                                                                                              - - email? - - factorType - - mfaToken -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -

                                                                                                                                                                                              Properties

                                                                                                                                                                                              -                                                                                                                                                                                               -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - email?: - string -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              - Email address (optional, uses user's email if not provided) -

                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - factorType: - "email" -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              The factor type for enrollment

                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              - mfaToken: - string -
                                                                                                                                                                                              -
                                                                                                                                                                                              -

                                                                                                                                                                                              MFA token from mfa_required error

                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -

                                                                                                                                                                                              Settings

                                                                                                                                                                                              -                                                                                                                                                                                               -
                                                                                                                                                                                              -
                                                                                                                                                                                              - Member Visibility -
                                                                                                                                                                                                -
                                                                                                                                                                                              • - -
                                                                                                                                                                                                • -
                                                                                                                                                                                              • - -
                                                                                                                                                                                                • -
                                                                                                                                                                                              • - -
                                                                                                                                                                                                • -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              -                                                                                                                                                                                               -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - Properties - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - +EnrollEmailParams | @auth0/auth0-angular
                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface EnrollEmailParams

                                                                                                                                                                                                Email enrollment parameters

                                                                                                                                                                                                +
                                                                                                                                                                                                interface EnrollEmailParams {
                                                                                                                                                                                                    email?: string;
                                                                                                                                                                                                    factorType: "email";
                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                }

                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                • EnrollBaseParams
                                                                                                                                                                                                  • EnrollEmailParams
                                                                                                                                                                                                Index

                                                                                                                                                                                                Properties

                                                                                                                                                                                                email? +factorType +mfaToken +

                                                                                                                                                                                                Properties

                                                                                                                                                                                                email?: string

                                                                                                                                                                                                Email address (optional, uses user's email if not provided)

                                                                                                                                                                                                +
                                                                                                                                                                                                factorType: "email"

                                                                                                                                                                                                The factor type for enrollment

                                                                                                                                                                                                +
                                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                                MFA token from mfa_required error

                                                                                                                                                                                                +

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                On This Page

                                                                                                                                                                                                Properties
                                                                                                                                                                                                diff --git a/docs/interfaces/EnrollOtpParams.html b/docs/interfaces/EnrollOtpParams.html index 21c55052..50500b68 100644 --- a/docs/interfaces/EnrollOtpParams.html +++ b/docs/interfaces/EnrollOtpParams.html @@ -1,454 +1,6 @@ - - - - - - EnrollOtpParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -                                                                                                                                                                                                   - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  Interface EnrollOtpParams

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  OTP (Time-based One-Time Password) enrollment parameters

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - interface - EnrollOtpParams - {
                                                                                                                                                                                                      factorType: - "otp";
                                                                                                                                                                                                      mfaToken: - string;
                                                                                                                                                                                                  } -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                  -
                                                                                                                                                                                                    -
                                                                                                                                                                                                  • - EnrollBaseParams -
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • - EnrollOtpParams -
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  Index
                                                                                                                                                                                                  -                                                                                                                                                                                                   -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - factorType - - mfaToken -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  -                                                                                                                                                                                                   -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - factorType: - "otp" -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  The factor type for enrollment

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - mfaToken: - string -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  MFA token from mfa_required error

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  -                                                                                                                                                                                                   -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - Member Visibility -
                                                                                                                                                                                                    -
                                                                                                                                                                                                  • - -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • - -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • - -
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  -                                                                                                                                                                                                   -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - Properties - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - +EnrollOtpParams | @auth0/auth0-angular
                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface EnrollOtpParams

                                                                                                                                                                                                    OTP (Time-based One-Time Password) enrollment parameters

                                                                                                                                                                                                    +
                                                                                                                                                                                                    interface EnrollOtpParams {
                                                                                                                                                                                                        factorType: "otp";
                                                                                                                                                                                                        mfaToken: string;
                                                                                                                                                                                                    }

                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                    • EnrollBaseParams
                                                                                                                                                                                                      • EnrollOtpParams
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    factorType +mfaToken +

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    factorType: "otp"

                                                                                                                                                                                                    The factor type for enrollment

                                                                                                                                                                                                    +
                                                                                                                                                                                                    mfaToken: string

                                                                                                                                                                                                    MFA token from mfa_required error

                                                                                                                                                                                                    +

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    diff --git a/docs/interfaces/EnrollPushParams.html b/docs/interfaces/EnrollPushParams.html index 8e6afc00..433d36b1 100644 --- a/docs/interfaces/EnrollPushParams.html +++ b/docs/interfaces/EnrollPushParams.html @@ -1,454 +1,6 @@ - - - - - - EnrollPushParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -                                                                                                                                                                                                       - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      Interface EnrollPushParams

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Push notification enrollment parameters

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - interface - EnrollPushParams - {
                                                                                                                                                                                                          factorType: - "push";
                                                                                                                                                                                                          mfaToken: - string;
                                                                                                                                                                                                      } -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                      -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • - EnrollBaseParams -
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • - EnrollPushParams -
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -
                                                                                                                                                                                                      Index
                                                                                                                                                                                                      -                                                                                                                                                                                                       -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - factorType - - mfaToken -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      -                                                                                                                                                                                                       -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - factorType: - "push" -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      The factor type for enrollment

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      - mfaToken: - string -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      MFA token from mfa_required error

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      -                                                                                                                                                                                                       -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - Member Visibility -
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • - -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • - -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • - -
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      -                                                                                                                                                                                                       -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - Properties - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - +EnrollPushParams | @auth0/auth0-angular
                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface EnrollPushParams

                                                                                                                                                                                                        Push notification enrollment parameters

                                                                                                                                                                                                        +
                                                                                                                                                                                                        interface EnrollPushParams {
                                                                                                                                                                                                            factorType: "push";
                                                                                                                                                                                                            mfaToken: string;
                                                                                                                                                                                                        }

                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                        • EnrollBaseParams
                                                                                                                                                                                                          • EnrollPushParams
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        factorType +mfaToken +

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        factorType: "push"

                                                                                                                                                                                                        The factor type for enrollment

                                                                                                                                                                                                        +
                                                                                                                                                                                                        mfaToken: string

                                                                                                                                                                                                        MFA token from mfa_required error

                                                                                                                                                                                                        +

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                        Properties
                                                                                                                                                                                                        diff --git a/docs/interfaces/EnrollSmsParams.html b/docs/interfaces/EnrollSmsParams.html index 8032fe20..a60f41ef 100644 --- a/docs/interfaces/EnrollSmsParams.html +++ b/docs/interfaces/EnrollSmsParams.html @@ -1,507 +1,8 @@ - - - - - - EnrollSmsParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -                                                                                                                                                                                                           - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          Interface EnrollSmsParams

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          SMS enrollment parameters

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - interface - EnrollSmsParams - {
                                                                                                                                                                                                              factorType: - "sms";
                                                                                                                                                                                                              mfaToken: - string;
                                                                                                                                                                                                              phoneNumber: - string;
                                                                                                                                                                                                          } -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • - EnrollBaseParams -
                                                                                                                                                                                                              -
                                                                                                                                                                                                            • - EnrollSmsParams -
                                                                                                                                                                                                              • -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -
                                                                                                                                                                                                          Index
                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - factorType - - mfaToken - - phoneNumber -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          - factorType: - "sms" -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          The factor type for enrollment

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          - mfaToken: - string -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          MFA token from mfa_required error

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          - phoneNumber: - string -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Phone number in E.164 format (required for SMS)

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - Member Visibility -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • - -
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • - -
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • - -
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - Properties - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - +EnrollSmsParams | @auth0/auth0-angular
                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface EnrollSmsParams

                                                                                                                                                                                                            SMS enrollment parameters

                                                                                                                                                                                                            +
                                                                                                                                                                                                            interface EnrollSmsParams {
                                                                                                                                                                                                                factorType: "sms";
                                                                                                                                                                                                                mfaToken: string;
                                                                                                                                                                                                                phoneNumber: string;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                            • EnrollBaseParams
                                                                                                                                                                                                              • EnrollSmsParams
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            factorType +mfaToken +phoneNumber +

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            factorType: "sms"

                                                                                                                                                                                                            The factor type for enrollment

                                                                                                                                                                                                            +
                                                                                                                                                                                                            mfaToken: string

                                                                                                                                                                                                            MFA token from mfa_required error

                                                                                                                                                                                                            +
                                                                                                                                                                                                            phoneNumber: string

                                                                                                                                                                                                            Phone number in E.164 format (required for SMS)

                                                                                                                                                                                                            +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            diff --git a/docs/interfaces/EnrollVoiceParams.html b/docs/interfaces/EnrollVoiceParams.html index 046dd9ea..8213a21d 100644 --- a/docs/interfaces/EnrollVoiceParams.html +++ b/docs/interfaces/EnrollVoiceParams.html @@ -1,507 +1,8 @@ - - - - - - EnrollVoiceParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -                                                                                                                                                                                                               - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -

                                                                                                                                                                                                              Interface EnrollVoiceParams

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Voice enrollment parameters

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - interface - EnrollVoiceParams - {
                                                                                                                                                                                                                  factorType: - "voice";
                                                                                                                                                                                                                  mfaToken: - string;
                                                                                                                                                                                                                  phoneNumber: - string;
                                                                                                                                                                                                              } -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                              -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • - EnrollBaseParams -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • - EnrollVoiceParams -
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -
                                                                                                                                                                                                              Index
                                                                                                                                                                                                              -                                                                                                                                                                                                               -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - factorType - - mfaToken - - phoneNumber -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              -                                                                                                                                                                                                               -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              - factorType: - "voice" -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              The factor type for enrollment

                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              - mfaToken: - string -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              MFA token from mfa_required error

                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              - phoneNumber: - string -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Phone number in E.164 format (required for voice)

                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              -                                                                                                                                                                                                               -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - Member Visibility -
                                                                                                                                                                                                                -
                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              -                                                                                                                                                                                                               -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - Properties - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - +EnrollVoiceParams | @auth0/auth0-angular
                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface EnrollVoiceParams

                                                                                                                                                                                                                Voice enrollment parameters

                                                                                                                                                                                                                +
                                                                                                                                                                                                                interface EnrollVoiceParams {
                                                                                                                                                                                                                    factorType: "voice";
                                                                                                                                                                                                                    mfaToken: string;
                                                                                                                                                                                                                    phoneNumber: string;
                                                                                                                                                                                                                }

                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                • EnrollBaseParams
                                                                                                                                                                                                                  • EnrollVoiceParams
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                factorType +mfaToken +phoneNumber +

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                factorType: "voice"

                                                                                                                                                                                                                The factor type for enrollment

                                                                                                                                                                                                                +
                                                                                                                                                                                                                mfaToken: string

                                                                                                                                                                                                                MFA token from mfa_required error

                                                                                                                                                                                                                +
                                                                                                                                                                                                                phoneNumber: string

                                                                                                                                                                                                                Phone number in E.164 format (required for voice)

                                                                                                                                                                                                                +

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                diff --git a/docs/interfaces/EnrollmentFactor.html b/docs/interfaces/EnrollmentFactor.html index b3bce1d3..f00a9153 100644 --- a/docs/interfaces/EnrollmentFactor.html +++ b/docs/interfaces/EnrollmentFactor.html @@ -1,382 +1,4 @@ - - - - - - EnrollmentFactor | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -                                                                                                                                                                                                                   - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                  Interface EnrollmentFactor

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Enrollment factor returned by getEnrollmentFactors

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - interface - EnrollmentFactor - {
                                                                                                                                                                                                                      type: - string;
                                                                                                                                                                                                                  } -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                  -                                                                                                                                                                                                                   -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - type -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  -                                                                                                                                                                                                                   -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - type: - string -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Type of enrollment factor available

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  -                                                                                                                                                                                                                   -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - Member Visibility -
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  -                                                                                                                                                                                                                   -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - Properties - -
                                                                                                                                                                                                                  - - type -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - +EnrollmentFactor | @auth0/auth0-angular
                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface EnrollmentFactor

                                                                                                                                                                                                                    Enrollment factor returned by getEnrollmentFactors

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    interface EnrollmentFactor {
                                                                                                                                                                                                                        type: string;
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    type +

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    type: string

                                                                                                                                                                                                                    Type of enrollment factor available

                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    diff --git a/docs/interfaces/Factor.html b/docs/interfaces/Factor.html new file mode 100644 index 00000000..d4a00f3f --- /dev/null +++ b/docs/interfaces/Factor.html @@ -0,0 +1,3 @@ +Factor | @auth0/auth0-angular
                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface Factor

                                                                                                                                                                                                                      interface Factor {
                                                                                                                                                                                                                          type: AuthenticationMethodType;
                                                                                                                                                                                                                          usage?: ("primary" | "secondary")[];
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      type +usage? +

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      type: AuthenticationMethodType
                                                                                                                                                                                                                      usage?: ("primary" | "secondary")[]

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 6b75c622..fa765c49 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,693 +1,25 @@ - - - - - - GetTokenSilentlyOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        Interface GetTokenSilentlyOptions

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - interface - GetTokenSilentlyOptions - {
                                                                                                                                                                                                                            authorizationParams?: - {
                                                                                                                                                                                                                                audience?: - string;
                                                                                                                                                                                                                                redirect_uri?: - string;
                                                                                                                                                                                                                                scope?: - string;
                                                                                                                                                                                                                                [key: - string]: - any;
                                                                                                                                                                                                                            };
                                                                                                                                                                                                                            cacheMode?: - "off"
                                                                                                                                                                                                                            | - "on"
                                                                                                                                                                                                                            | - "cache-only";
                                                                                                                                                                                                                            detailedResponse?: - boolean;
                                                                                                                                                                                                                            timeoutInSeconds?: - number;
                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - authorizationParams? - - cacheMode? - - detailedResponse? - - timeoutInSeconds? -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - authorizationParams?: - {
                                                                                                                                                                                                                            audience?: - string;
                                                                                                                                                                                                                            redirect_uri?: - string;
                                                                                                                                                                                                                            scope?: - string;
                                                                                                                                                                                                                            [key: - string]: - any;
                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        - Parameters that will be sent back to Auth0 as part of a - request. -

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                          - [key: - string]: - any -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          - If you need to send custom parameters to the - Authorization Server, make sure to use the original - parameter name. -

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                          - Optionalaudience?: string -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          - The audience that was used in the authentication request -

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                          - Optionalredirect_uri?: string -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          - There's no actual redirect when getting a token - silently, but, according to the spec, a - redirect_uri param is required. Auth0 uses - this parameter to validate that the current - origin matches the - redirect_uri origin when - sending the response. It must be whitelisted in the - "Allowed Web Origins" in your Auth0 - Application's settings. -

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                          - Optionalscope?: string -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          - The scope that was used in the authentication request -

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - cacheMode?: - "off" - | - "on" - | - "cache-only" -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        - When off, ignores the cache and always sends a - request to Auth0. When cache-only, only reads - from the cache and never sends a request to Auth0. Defaults to - on, where it both reads from the cache and sends - a request to Auth0 as needed. -

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - detailedResponse?: - boolean -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        - If true, the full response from the /oauth/token endpoint (or - the cache, if the cache was used) is returned (minus - refresh_token if one was issued). Otherwise, just - the access token is returned. -

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        The default is false.

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        - timeoutInSeconds?: - number -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        - A maximum number of seconds to wait before declaring the - background /authorize call as failed for timeout Defaults to - 60s. -

                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                        - - +GetTokenSilentlyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Interface GetTokenSilentlyOptions

                                                                                                                                                                                                                          interface GetTokenSilentlyOptions {
                                                                                                                                                                                                                              authorizationParams?: {
                                                                                                                                                                                                                                  audience?: string;
                                                                                                                                                                                                                                  redirect_uri?: string;
                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                                                                              };
                                                                                                                                                                                                                              cacheMode?: "off"
                                                                                                                                                                                                                              | "on"
                                                                                                                                                                                                                              | "cache-only";
                                                                                                                                                                                                                              detailedResponse?: boolean;
                                                                                                                                                                                                                              timeoutInSeconds?: number;
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          authorizationParams? +cacheMode? +detailedResponse? +timeoutInSeconds? +

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          authorizationParams?: {
                                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                                              redirect_uri?: string;
                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                          }

                                                                                                                                                                                                                          Parameters that will be sent back to Auth0 as part of a request.

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                          • [key: string]: any

                                                                                                                                                                                                                            If you need to send custom parameters to the Authorization Server, +make sure to use the original parameter name.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                          • Optionalaudience?: string

                                                                                                                                                                                                                            The audience that was used in the authentication request

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                          • Optionalredirect_uri?: string

                                                                                                                                                                                                                            There's no actual redirect when getting a token silently, +but, according to the spec, a redirect_uri param is required. +Auth0 uses this parameter to validate that the current origin +matches the redirect_uri origin when sending the response. +It must be whitelisted in the "Allowed Web Origins" in your +Auth0 Application's settings.

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                          • Optionalscope?: string

                                                                                                                                                                                                                            The scope that was used in the authentication request

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                          cacheMode?: "off" | "on" | "cache-only"

                                                                                                                                                                                                                          When off, ignores the cache and always sends a +request to Auth0. +When cache-only, only reads from the cache and never sends a request to Auth0. +Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          detailedResponse?: boolean

                                                                                                                                                                                                                          If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned +(minus refresh_token if one was issued). Otherwise, just the access token is returned.

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          The default is false.

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          timeoutInSeconds?: number

                                                                                                                                                                                                                          A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout +Defaults to 60s.

                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 737f47c7..b5228956 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,494 +1,8 @@ - - - - - - GetTokenWithPopupOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                            Interface GetTokenWithPopupOptions

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - interface - GetTokenWithPopupOptions - {
                                                                                                                                                                                                                                authorizationParams?: - AuthorizationParams;
                                                                                                                                                                                                                                cacheMode?: - "off" - | - "on" - | - "cache-only";
                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            - Hierarchy (View Summary) -

                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - authorizationParams? - - cacheMode? -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - authorizationParams?: - AuthorizationParams -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            - URL parameters that will be sent back to the Authorization - Server. This can be known parameters defined by Auth0 or - custom parameters that you define. -

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            - cacheMode?: - "off" - | - "on" - | - "cache-only" -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            - When off, ignores the cache and always sends a - request to Auth0. When cache-only, only reads - from the cache and never sends a request to Auth0. Defaults to - on, where it both reads from the cache and sends - a request to Auth0 as needed. -

                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - Properties - - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                            - - +GetTokenWithPopupOptions | @auth0/auth0-angular
                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface GetTokenWithPopupOptions

                                                                                                                                                                                                                              interface GetTokenWithPopupOptions {
                                                                                                                                                                                                                                  authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                  cacheMode?: "off" | "on" | "cache-only";
                                                                                                                                                                                                                              }

                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              authorizationParams? +cacheMode? +

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              authorizationParams?: AuthorizationParams

                                                                                                                                                                                                                              URL parameters that will be sent back to the Authorization Server. This can be known parameters +defined by Auth0 or custom parameters that you define.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              cacheMode?: "off" | "on" | "cache-only"

                                                                                                                                                                                                                              When off, ignores the cache and always sends a request to Auth0. +When cache-only, only reads from the cache and never sends a request to Auth0. +Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              diff --git a/docs/interfaces/HttpInterceptorConfig.html b/docs/interfaces/HttpInterceptorConfig.html index e80720f8..d21c186b 100644 --- a/docs/interfaces/HttpInterceptorConfig.html +++ b/docs/interfaces/HttpInterceptorConfig.html @@ -1,396 +1,3 @@ - - - - - - HttpInterceptorConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                Interface HttpInterceptorConfig

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Configuration for the HttpInterceptor

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - interface - HttpInterceptorConfig - {
                                                                                                                                                                                                                                    allowedList: - ApiRouteDefinition[];
                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - allowedList -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                - allowedList: - ApiRouteDefinition[] -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                - - +HttpInterceptorConfig | @auth0/auth0-angular
                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface HttpInterceptorConfig

                                                                                                                                                                                                                                  Configuration for the HttpInterceptor

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  interface HttpInterceptorConfig {
                                                                                                                                                                                                                                      allowedList: ApiRouteDefinition[];
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  allowedList +

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  allowedList: ApiRouteDefinition[]

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                  diff --git a/docs/interfaces/HttpInterceptorRouteConfig.html b/docs/interfaces/HttpInterceptorRouteConfig.html index 2e6ca0ef..509d7e74 100644 --- a/docs/interfaces/HttpInterceptorRouteConfig.html +++ b/docs/interfaces/HttpInterceptorRouteConfig.html @@ -1,693 +1,29 @@ - - - - - - HttpInterceptorRouteConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    Interface HttpInterceptorRouteConfig

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Configuration for a single interceptor route

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - interface - HttpInterceptorRouteConfig - {
                                                                                                                                                                                                                                        allowAnonymous?: - boolean;
                                                                                                                                                                                                                                        httpMethod?: - string;
                                                                                                                                                                                                                                        tokenOptions?: - GetTokenSilentlyOptions;
                                                                                                                                                                                                                                        uri?: - string;
                                                                                                                                                                                                                                        uriMatcher?: - (uri: - string) - => - boolean;
                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - allowAnonymous? - - httpMethod? - - tokenOptions? - - uri? - - uriMatcher? -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - allowAnonymous?: - boolean -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - Allow the HTTP call to be executed anonymously, when no token - is available. -

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - When omitted (or set to false), calls that match the - configuration will fail when no token is available. -

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - httpMethod?: - string -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - The HTTP method to match on. If specified, the HTTP method of - the outgoing request will be checked against this. If there is - no match, the Authorization header is not attached. -

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    The HTTP method name is case-sensitive.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - tokenOptions?: - GetTokenSilentlyOptions -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - The options that are passed to the SDK when retrieving the - access token to attach to the outgoing request. -

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - uri?: - string -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - The URL to test, by supplying the URL to match. If - test is a match for the current request path from - the HTTP client, then an access token is attached to the - request in the - "Authorization" header. -

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - If the test does not pass, the request proceeds without the - access token attached. -

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - A wildcard character can be used to match only the start of - the URL. -

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    - '/api' - exactly match the route /api '/api/*' - match any - route that starts with /api/ -

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    - uriMatcher?: - (uri: - string) - => - boolean -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - A function that will be called with the HttpRequest.url value, - allowing you to do any kind of flexible matching. -

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - If this function returns true, then an access token is - attached to the request in the - "Authorization" header. -

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    - If it returns false, the request proceeds without the access - token attached. -

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - Properties - - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - - +HttpInterceptorRouteConfig | @auth0/auth0-angular
                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface HttpInterceptorRouteConfig

                                                                                                                                                                                                                                      Configuration for a single interceptor route

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      interface HttpInterceptorRouteConfig {
                                                                                                                                                                                                                                          allowAnonymous?: boolean;
                                                                                                                                                                                                                                          httpMethod?: string;
                                                                                                                                                                                                                                          tokenOptions?: GetTokenSilentlyOptions;
                                                                                                                                                                                                                                          uri?: string;
                                                                                                                                                                                                                                          uriMatcher?: (uri: string) => boolean;
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      allowAnonymous? +httpMethod? +tokenOptions? +uri? +uriMatcher? +

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      allowAnonymous?: boolean

                                                                                                                                                                                                                                      Allow the HTTP call to be executed anonymously, when no token is available.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      When omitted (or set to false), calls that match the configuration will fail when no token is available.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      httpMethod?: string

                                                                                                                                                                                                                                      The HTTP method to match on. If specified, the HTTP method of +the outgoing request will be checked against this. If there is no match, the +Authorization header is not attached.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      The HTTP method name is case-sensitive.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      tokenOptions?: GetTokenSilentlyOptions

                                                                                                                                                                                                                                      The options that are passed to the SDK when retrieving the +access token to attach to the outgoing request.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      uri?: string

                                                                                                                                                                                                                                      The URL to test, by supplying the URL to match. +If test is a match for the current request path from the HTTP client, then +an access token is attached to the request in the +"Authorization" header.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      If the test does not pass, the request proceeds without the access token attached.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      A wildcard character can be used to match only the start of the URL.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      '/api' - exactly match the route /api +'/api/*' - match any route that starts with /api/

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      uriMatcher?: (uri: string) => boolean

                                                                                                                                                                                                                                      A function that will be called with the HttpRequest.url value, allowing you to do +any kind of flexible matching.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      If this function returns true, then +an access token is attached to the request in the +"Authorization" header.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      If it returns false, the request proceeds without the access token attached.

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index c8558514..c36b664b 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,813 +1,5 @@ - - - - - - ICache | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                        Interface ICache

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - interface - ICache - {
                                                                                                                                                                                                                                            allKeys?(): - MaybePromise<string[]>;
                                                                                                                                                                                                                                            get<T - = - Cacheable>(key: - string): - MaybePromise<T - | - undefined>;
                                                                                                                                                                                                                                            remove(key: - string): - MaybePromise<void>;
                                                                                                                                                                                                                                            set<T - = - Cacheable>(key: - string, - entry: - T): - MaybePromise<void>;
                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Implemented by

                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - allKeys? - - get - - remove - - set -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          - Returns - MaybePromise<string[]> -

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • - key: - string -
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          - Returns - MaybePromise<T - | - undefined> -

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • - key: - string -
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          - Returns - MaybePromise<void> -

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • - key: - string -
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • - entry: - T -
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          - Returns - MaybePromise<void> -

                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - Methods - - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        - - +ICache | @auth0/auth0-angular
                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Interface ICache

                                                                                                                                                                                                                                          interface ICache {
                                                                                                                                                                                                                                              allKeys?(): MaybePromise<string[]>;
                                                                                                                                                                                                                                              get<T = Cacheable>(key: string): MaybePromise<T | undefined>;
                                                                                                                                                                                                                                              remove(key: string): MaybePromise<void>;
                                                                                                                                                                                                                                              set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                          Implemented by

                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          allKeys? +get +remove +set +

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          • Returns MaybePromise<string[]>

                                                                                                                                                                                                                                          • Type Parameters

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • key: string

                                                                                                                                                                                                                                            Returns MaybePromise<T | undefined>

                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                            • key: string

                                                                                                                                                                                                                                            Returns MaybePromise<void>

                                                                                                                                                                                                                                          • Type Parameters

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • key: string
                                                                                                                                                                                                                                            • entry: T

                                                                                                                                                                                                                                            Returns MaybePromise<void>

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                          diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 0c43dfca..11db9a4a 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,2153 +1,43 @@ - - - - - - IdToken | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                            Interface IdToken

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - interface - IdToken - {
                                                                                                                                                                                                                                                __raw: - string;
                                                                                                                                                                                                                                                acr?: - string;
                                                                                                                                                                                                                                                address?: - string;
                                                                                                                                                                                                                                                amr?: - string[];
                                                                                                                                                                                                                                                at_hash?: - string;
                                                                                                                                                                                                                                                aud?: - string;
                                                                                                                                                                                                                                                auth_time?: - string;
                                                                                                                                                                                                                                                azp?: - string;
                                                                                                                                                                                                                                                birthdate?: - string;
                                                                                                                                                                                                                                                c_hash?: - string;
                                                                                                                                                                                                                                                cnf?: - string;
                                                                                                                                                                                                                                                email?: - string;
                                                                                                                                                                                                                                                email_verified?: - boolean;
                                                                                                                                                                                                                                                exp?: - number;
                                                                                                                                                                                                                                                family_name?: - string;
                                                                                                                                                                                                                                                gender?: - string;
                                                                                                                                                                                                                                                given_name?: - string;
                                                                                                                                                                                                                                                iat?: - number;
                                                                                                                                                                                                                                                iss?: - string;
                                                                                                                                                                                                                                                jti?: - string;
                                                                                                                                                                                                                                                locale?: - string;
                                                                                                                                                                                                                                                middle_name?: - string;
                                                                                                                                                                                                                                                name?: - string;
                                                                                                                                                                                                                                                nbf?: - number;
                                                                                                                                                                                                                                                nickname?: - string;
                                                                                                                                                                                                                                                nonce?: - string;
                                                                                                                                                                                                                                                org_id?: - string;
                                                                                                                                                                                                                                                org_name?: - string;
                                                                                                                                                                                                                                                phone_number?: - string;
                                                                                                                                                                                                                                                phone_number_verified?: - boolean;
                                                                                                                                                                                                                                                picture?: - string;
                                                                                                                                                                                                                                                preferred_username?: - string;
                                                                                                                                                                                                                                                profile?: - string;
                                                                                                                                                                                                                                                sid?: - string;
                                                                                                                                                                                                                                                sub_jwk?: - string;
                                                                                                                                                                                                                                                updated_at?: - string;
                                                                                                                                                                                                                                                website?: - string;
                                                                                                                                                                                                                                                zoneinfo?: - string;
                                                                                                                                                                                                                                                [key: - string]: - any;
                                                                                                                                                                                                                                            } -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                              - [key: - string]: - any -
                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - __raw - - acr? - - address? - - amr? - - at_hash? - - aud? - - auth_time? - - azp? - - birthdate? - - c_hash? - - cnf? - - email? - - email_verified? - - exp? - - family_name? - - gender? - - given_name? - - iat? - - iss? - - jti? - - locale? - - middle_name? - - name? - - nbf? - - nickname? - - nonce? - - org_id? - - org_name? - - phone_number? - - phone_number_verified? - - picture? - - preferred_username? - - profile? - - sid? - - sub_jwk? - - updated_at? - - website? - - zoneinfo? -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            - __raw -

                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - __raw: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - acr?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - address?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - amr?: - string[] -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - at_hash?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - aud?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - auth_time?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - azp?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - birthdate?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - c_hash?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - cnf?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - email?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - email_verified?: - boolean -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - exp?: - number -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - family_name?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - gender?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - given_name?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - iat?: - number -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - iss?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - jti?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - locale?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - middle_name?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - name?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - nbf?: - number -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - nickname?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - nonce?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - org_id?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - org_name?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - phone_number?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - phone_number_verified?: - boolean -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - picture?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - preferred_username?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - profile?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - sid?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - sub_jwk?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - updated_at?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - website?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            - zoneinfo?: - string -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - Properties - - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                            - - +IdToken | @auth0/auth0-angular
                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface IdToken

                                                                                                                                                                                                                                              interface IdToken {
                                                                                                                                                                                                                                                  __raw: string;
                                                                                                                                                                                                                                                  acr?: string;
                                                                                                                                                                                                                                                  act?: ActClaim;
                                                                                                                                                                                                                                                  address?: string;
                                                                                                                                                                                                                                                  amr?: string[];
                                                                                                                                                                                                                                                  at_hash?: string;
                                                                                                                                                                                                                                                  aud?: string;
                                                                                                                                                                                                                                                  auth_time?: string;
                                                                                                                                                                                                                                                  azp?: string;
                                                                                                                                                                                                                                                  birthdate?: string;
                                                                                                                                                                                                                                                  c_hash?: string;
                                                                                                                                                                                                                                                  cnf?: string;
                                                                                                                                                                                                                                                  email?: string;
                                                                                                                                                                                                                                                  email_verified?: boolean;
                                                                                                                                                                                                                                                  exp?: number;
                                                                                                                                                                                                                                                  family_name?: string;
                                                                                                                                                                                                                                                  gender?: string;
                                                                                                                                                                                                                                                  given_name?: string;
                                                                                                                                                                                                                                                  iat?: number;
                                                                                                                                                                                                                                                  iss?: string;
                                                                                                                                                                                                                                                  jti?: string;
                                                                                                                                                                                                                                                  locale?: string;
                                                                                                                                                                                                                                                  middle_name?: string;
                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                  nbf?: number;
                                                                                                                                                                                                                                                  nickname?: string;
                                                                                                                                                                                                                                                  nonce?: string;
                                                                                                                                                                                                                                                  org_id?: string;
                                                                                                                                                                                                                                                  org_name?: string;
                                                                                                                                                                                                                                                  phone_number?: string;
                                                                                                                                                                                                                                                  phone_number_verified?: boolean;
                                                                                                                                                                                                                                                  picture?: string;
                                                                                                                                                                                                                                                  preferred_username?: string;
                                                                                                                                                                                                                                                  profile?: string;
                                                                                                                                                                                                                                                  sid?: string;
                                                                                                                                                                                                                                                  sub_jwk?: string;
                                                                                                                                                                                                                                                  updated_at?: string;
                                                                                                                                                                                                                                                  website?: string;
                                                                                                                                                                                                                                                  zoneinfo?: string;
                                                                                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                              • [key: string]: any
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              __raw +acr? +act? +address? +amr? +at_hash? +aud? +auth_time? +azp? +birthdate? +c_hash? +cnf? +email? +email_verified? +exp? +family_name? +gender? +given_name? +iat? +iss? +jti? +locale? +middle_name? +name? +nbf? +nickname? +nonce? +org_id? +org_name? +phone_number? +phone_number_verified? +picture? +preferred_username? +profile? +sid? +sub_jwk? +updated_at? +website? +zoneinfo? +

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              __raw

                                                                                                                                                                                                                                              __raw: string
                                                                                                                                                                                                                                              acr?: string
                                                                                                                                                                                                                                              act?: ActClaim

                                                                                                                                                                                                                                              The actor claim, present in ID tokens returned via token exchange responses. +Identifies the acting party that has been delegated authority to act on behalf +of the subject. Set via Auth0 Actions using the setActor command.

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              address?: string
                                                                                                                                                                                                                                              amr?: string[]
                                                                                                                                                                                                                                              at_hash?: string
                                                                                                                                                                                                                                              aud?: string
                                                                                                                                                                                                                                              auth_time?: string
                                                                                                                                                                                                                                              azp?: string
                                                                                                                                                                                                                                              birthdate?: string
                                                                                                                                                                                                                                              c_hash?: string
                                                                                                                                                                                                                                              cnf?: string
                                                                                                                                                                                                                                              email?: string
                                                                                                                                                                                                                                              email_verified?: boolean
                                                                                                                                                                                                                                              exp?: number
                                                                                                                                                                                                                                              family_name?: string
                                                                                                                                                                                                                                              gender?: string
                                                                                                                                                                                                                                              given_name?: string
                                                                                                                                                                                                                                              iat?: number
                                                                                                                                                                                                                                              iss?: string
                                                                                                                                                                                                                                              jti?: string
                                                                                                                                                                                                                                              locale?: string
                                                                                                                                                                                                                                              middle_name?: string
                                                                                                                                                                                                                                              name?: string
                                                                                                                                                                                                                                              nbf?: number
                                                                                                                                                                                                                                              nickname?: string
                                                                                                                                                                                                                                              nonce?: string
                                                                                                                                                                                                                                              org_id?: string
                                                                                                                                                                                                                                              org_name?: string
                                                                                                                                                                                                                                              phone_number?: string
                                                                                                                                                                                                                                              phone_number_verified?: boolean
                                                                                                                                                                                                                                              picture?: string
                                                                                                                                                                                                                                              preferred_username?: string
                                                                                                                                                                                                                                              profile?: string
                                                                                                                                                                                                                                              sid?: string
                                                                                                                                                                                                                                              sub_jwk?: string
                                                                                                                                                                                                                                              updated_at?: string
                                                                                                                                                                                                                                              website?: string
                                                                                                                                                                                                                                              zoneinfo?: string

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 081efc0e..029ffa74 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,713 +1,31 @@ - - - - - - LogoutOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                Interface LogoutOptions

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - interface - LogoutOptions - {
                                                                                                                                                                                                                                                    clientId?: - string - | - null;
                                                                                                                                                                                                                                                    logoutParams?: - {
                                                                                                                                                                                                                                                        federated?: - boolean;
                                                                                                                                                                                                                                                        returnTo?: - string;
                                                                                                                                                                                                                                                        [key: - string]: - any;
                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                    openUrl?: - false
                                                                                                                                                                                                                                                    | - ((url: - string) - => - void - | - Promise<void>);
                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                • - Omit<SPALogoutOptions, - "onRedirect"> -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • - LogoutOptions -
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - clientId? - - logoutParams? - - openUrl? -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                - clientId?: - string - | - null -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                The clientId of your application.

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - If this property is not set, then the - clientId that was used during initialization of - the SDK is sent to the logout endpoint. -

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - If this property is set to null, then no client - ID value is sent to the logout endpoint. -

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - Read more about how redirecting after logout works -

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                - logoutParams?: - { - federated?: - boolean; - returnTo?: - string; - [key: - string]: - any - } -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - Parameters to pass to the logout endpoint. This can be known - parameters defined by Auth0 or custom parameters you wish to - provide. -

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                  - [key: - string]: - any -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  - If you need to send custom parameters to the logout - endpoint, make sure to use the original parameter name. -

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                  - Optionalfederated?: boolean -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  - When supported by the upstream identity provider, forces - the user to logout of their identity provider and from - Auth0. - Read more about how federated logout works at - Auth0 -

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                  - OptionalreturnTo?: string -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  - The URL where Auth0 will redirect your browser to after - the logout. -

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  - Note: If the - client_id parameter is included, the - returnTo URL that is provided must be - listed in the Application's "Allowed Logout - URLs" in the Auth0 dashboard. However, if the - client_id parameter is not included, the - returnTo URL must be listed in the - "Allowed Logout URLs" at the account level in - the Auth0 dashboard. -

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  - Read more about how redirecting after logout works -

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                - openUrl?: - false - | ((url: - string) - => - void - | - Promise<void>) -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - Used to control the redirect and not rely on the SDK to do the - actual redirect. -

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                - Set to false to disable the redirect, or provide - a function to handle the actual redirect yourself. -

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                - - 
                                                                                                                                                                                                                                                await auth0.logout({
                                                                                                                                                                                                                                                  openUrl(url) {
                                                                                                                                                                                                                                                    window.location.replace(url);
                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                });
+LogoutOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                  Interface LogoutOptions
                                                                                                                                                                                                                                                  interface LogoutOptions {
                                                                                                                                                                                                                                                      clientId?: string | null;
                                                                                                                                                                                                                                                      logoutParams?: {
                                                                                                                                                                                                                                                          federated?: boolean;
                                                                                                                                                                                                                                                          returnTo?: string;
                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                      openUrl?: false
                                                                                                                                                                                                                                                      | ((url: string) => void | Promise<void>);
                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                  Hierarchy
                                                                                                                                                                                                                                                  • Omit<SPALogoutOptions, "onRedirect">
                                                                                                                                                                                                                                                    • LogoutOptions
                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                  clientId?
+logoutParams?
+openUrl?
+
                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                  clientId?: string | null
                                                                                                                                                                                                                                                  The clientId of your application.
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  If this property is set to null, then no client ID value is sent to the logout endpoint.
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  Read more about how redirecting after logout works
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  logoutParams?: { federated?: boolean; returnTo?: string; [key: string]: any }
                                                                                                                                                                                                                                                  Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters
+you wish to provide.
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  Type Declaration
                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                    If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                  • Optionalfederated?: boolean
                                                                                                                                                                                                                                                    When supported by the upstream identity provider,
+forces the user to logout of their identity provider
+and from Auth0.
+Read more about how federated logout works at Auth0
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                  • OptionalreturnTo?: string
                                                                                                                                                                                                                                                    The URL where Auth0 will redirect your browser to after the logout.
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                    Note: If the client_id parameter is included, the
+returnTo URL that is provided must be listed in the
+Application's "Allowed Logout URLs" in the Auth0 dashboard.
+However, if the client_id parameter is not included, the
+returnTo URL must be listed in the "Allowed Logout URLs" at
+the account level in the Auth0 dashboard.
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                    Read more about how redirecting after logout works
                                                                                                                                                                                                                                                    
+
                                                                                                                                                                                                                                                  openUrl?: false | ((url: string) => void | Promise<void>)
                                                                                                                                                                                                                                                  Used to control the redirect and not rely on the SDK to do the actual redirect.
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  Set to false to disable the redirect, or provide a function to handle the actual redirect yourself.
                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                  await auth0.logout({
                                                                                                                                                                                                                                                    openUrl(url) {
                                                                                                                                                                                                                                                      window.location.replace(url);
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                  });
 
                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                  
-                  
-                  
                                                                                                                                                                                                                                                  import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                  await auth0.logout({
                                                                                                                                                                                                                                                    async openUrl(url) {
                                                                                                                                                                                                                                                      await Browser.open({ url });
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                  });
+
+
                                                                                                                                                                                                                                                  import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                  await auth0.logout({
                                                                                                                                                                                                                                                    async openUrl(url) {
                                                                                                                                                                                                                                                      await Browser.open({ url });
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                  });
 
                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                  
-              
                                                                                                                                                                                                                                                  
-              
-            
                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                  
-      
                                                                                                                                                                                                                                                  
-      
                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                  
-            
                                                                                                                                                                                                                                                  
-              
-                
-                
                                                                                                                                                                                                                                                  Settings
                                                                                                                                                                                                                                                  
-                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                  
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                    
-                    
                                                                                                                                                                                                                                                  • 
-                      
-                    
                                                                                                                                                                                                                                                    • 
-                    
                                                                                                                                                                                                                                                  • 
-                      
-                    
                                                                                                                                                                                                                                                    • 
-                    
                                                                                                                                                                                                                                                  • 
-                      
-                    
                                                                                                                                                                                                                                                    • 
-                  
                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                  
-                
                                                                                                                                                                                                                                                  
-                  
-                
                                                                                                                                                                                                                                                  
-              
                                                                                                                                                                                                                                                  
-            
                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                  
-            
-              
-              
                                                                                                                                                                                                                                                  On This Page
                                                                                                                                                                                                                                                  
-                                                                                                                                                                                                                                                              
-            
                                                                                                                                                                                                                                                  
-              
                                                                                                                                                                                                                                                  
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                                                                                                  
-            
                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                  
-        
                                                                                                                                                                                                                                                  
-          
-        
                                                                                                                                                                                                                                                  
-      
                                                                                                                                                                                                                                                  
-    
                                                                                                                                                                                                                                                  
-    
                                                                                                                                                                                                                                                  
-    
                                                                                                                                                                                                                                                  
-  
-
+
+

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/MyAccountApiClient.html b/docs/interfaces/MyAccountApiClient.html new file mode 100644 index 00000000..85febfce --- /dev/null +++ b/docs/interfaces/MyAccountApiClient.html @@ -0,0 +1,46 @@ +MyAccountApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface MyAccountApiClient

                                                                                                                                                                                                                                                    Client for Auth0 MyAccount API operations.

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Provides methods for managing the current user's account:

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                    • Connected accounts (link/unlink external identity providers)
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • MFA factors
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • Authentication methods (passkeys, phone, email, TOTP) - list, get, update, delete
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • Authentication method enrollment (challenge and verify)
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    interface MyAccountApiClient {
                                                                                                                                                                                                                                                        completeAccount(params: CompleteRequest): Promise<CompleteResponse>;
                                                                                                                                                                                                                                                        connectAccount(params: ConnectRequest): Promise<ConnectResponse>;
                                                                                                                                                                                                                                                        deleteAuthenticationMethod(id: string): Promise<void>;
                                                                                                                                                                                                                                                        enrollmentChallenge(
                                                                                                                                                                                                                                                            options: EnrollmentChallengeOptions,
                                                                                                                                                                                                                                                        ): Promise<EnrollmentChallengeResponse>;
                                                                                                                                                                                                                                                        enrollmentVerify(
                                                                                                                                                                                                                                                            options: EnrollmentVerifyOptions,
                                                                                                                                                                                                                                                        ): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                                        getAuthenticationMethod(id: string): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                                        getAuthenticationMethods(
                                                                                                                                                                                                                                                            type?: AuthenticationMethodType,
                                                                                                                                                                                                                                                        ): Promise<AuthenticationMethod[]>;
                                                                                                                                                                                                                                                        getFactors(): Promise<Factor[]>;
                                                                                                                                                                                                                                                        updateAuthenticationMethod(
                                                                                                                                                                                                                                                            id: string,
                                                                                                                                                                                                                                                            data: UpdateAuthenticationMethodRequest,
                                                                                                                                                                                                                                                        ): Promise<AuthenticationMethod>;
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                    completeAccount +connectAccount +deleteAuthenticationMethod +enrollmentChallenge +enrollmentVerify +getAuthenticationMethod +getAuthenticationMethods +getFactors +updateAuthenticationMethod +

                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                    • Verify the redirect from the connect account flow and complete the connecting of the account.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • params: CompleteRequest

                                                                                                                                                                                                                                                        Completion parameters including auth session, connect code, and redirect URI

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                      Returns Promise<CompleteResponse>

                                                                                                                                                                                                                                                      A promise that resolves to the completed connected account details

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Get a ticket for the connect account flow.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • params: ConnectRequest

                                                                                                                                                                                                                                                        Connection parameters including connection name and redirect URI

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                      Returns Promise<ConnectResponse>

                                                                                                                                                                                                                                                      A promise that resolves to a connect response with the redirect URI and auth session

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Delete an authentication method by ID.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • id: string

                                                                                                                                                                                                                                                        The ID of the authentication method to delete

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                      Returns Promise<void>

                                                                                                                                                                                                                                                      A promise that resolves when the authentication method has been deleted

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Start the enrollment of an authentication method for the current user. +The response shape varies by type.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      Returns Promise<EnrollmentChallengeResponse>

                                                                                                                                                                                                                                                      A promise that resolves to the enrollment challenge response (shape varies by type)

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Confirm the enrollment of an authentication method to complete registration.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • options: EnrollmentVerifyOptions

                                                                                                                                                                                                                                                        Enrollment verify options including the auth session and type-specific verification data

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                      Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                                      A promise that resolves to the confirmed authentication method

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Get an authentication method by ID.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • id: string

                                                                                                                                                                                                                                                        The ID of the authentication method to retrieve

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                      Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                                      A promise that resolves to the authentication method

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Get a list of all authentication methods for the current user.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      Returns Promise<AuthenticationMethod[]>

                                                                                                                                                                                                                                                      A promise that resolves to an array of authentication methods

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Get the status of all factors for the current user.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Returns Promise<Factor[]>

                                                                                                                                                                                                                                                      A promise that resolves to an array of factors with their enabled/disabled status

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    • Update details of an authentication method by ID.

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • id: string

                                                                                                                                                                                                                                                        The ID of the authentication method to update

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                      • data: UpdateAuthenticationMethodRequest

                                                                                                                                                                                                                                                        The fields to update (e.g. name, preferred_authentication_method for phone)

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                      Returns Promise<AuthenticationMethod>

                                                                                                                                                                                                                                                      A promise that resolves to the updated authentication method

                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/ObservableMfaApiClient.html b/docs/interfaces/ObservableMfaApiClient.html index 06307247..7fee7375 100644 --- a/docs/interfaces/ObservableMfaApiClient.html +++ b/docs/interfaces/ObservableMfaApiClient.html @@ -1,1036 +1,21 @@ - - - - - - ObservableMfaApiClient | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                       - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                      Interface ObservableMfaApiClient

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      - Observable-based MFA API client exposed by - AuthService.mfa. -

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      - This is the Angular counterpart of MfaApiClient from - @auth0/auth0-spa-js. All methods return - Observable instead of Promise. -

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - interface - ObservableMfaApiClient - {
                                                                                                                                                                                                                                                          challenge(
                                                                                                                                                                                                                                                              params: - ChallengeAuthenticatorParams,
                                                                                                                                                                                                                                                          ): - Observable<ChallengeResponse>;
                                                                                                                                                                                                                                                          enroll(params: - EnrollParams): - Observable<EnrollmentResponse>;
                                                                                                                                                                                                                                                          getAuthenticators(mfaToken: - string): - Observable<Authenticator[]>;
                                                                                                                                                                                                                                                          getEnrollmentFactors(mfaToken: - string): - Observable<EnrollmentFactor[]>;
                                                                                                                                                                                                                                                          verify(params: - VerifyParams): - Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                      } -
                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - -
                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - challenge - - enroll - - getAuthenticators - - getEnrollmentFactors - - verify -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        - Returns the list of enrolled MFA authenticators for the - current user, filtered by the challenge types stored in - the MFA context. -

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                        • - mfaToken: - string -
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        - Returns Observable<Authenticator[]> -

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        - Returns the available enrollment factors from the stored - MFA context. A non-empty result means the user must - enroll before they can authenticate. -

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                        • - mfaToken: - string -
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        - Returns Observable<EnrollmentFactor[]> -

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        - Verifies an MFA challenge and returns raw tokens. The - grant type is inferred automatically from the provided - field: otp, oobCode, or - recoveryCode. Angular auth state - (isAuthenticated$, user$) is - not updated automatically — call - getAccessTokenSilently() afterwards to - reflect the new session. -

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        - Returns Observable<TokenEndpointResponse> -

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - Member Visibility -
                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - Methods - - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      - - +ObservableMfaApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface ObservableMfaApiClient

                                                                                                                                                                                                                                                        Observable-based MFA API client exposed by AuthService.mfa.

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        This is the Angular counterpart of MfaApiClient from @auth0/auth0-spa-js. +All methods return Observable instead of Promise.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        interface ObservableMfaApiClient {
                                                                                                                                                                                                                                                            challenge(
                                                                                                                                                                                                                                                                params: ChallengeAuthenticatorParams,
                                                                                                                                                                                                                                                            ): Observable<ChallengeResponse>;
                                                                                                                                                                                                                                                            enroll(params: EnrollParams): Observable<EnrollmentResponse>;
                                                                                                                                                                                                                                                            getAuthenticators(mfaToken: string): Observable<Authenticator[]>;
                                                                                                                                                                                                                                                            getEnrollmentFactors(mfaToken: string): Observable<EnrollmentFactor[]>;
                                                                                                                                                                                                                                                            verify(params: VerifyParams): Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                        challenge +enroll +getAuthenticators +getEnrollmentFactors +verify +

                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/ObservableMyAccountApiClient.html b/docs/interfaces/ObservableMyAccountApiClient.html new file mode 100644 index 00000000..f57bd6be --- /dev/null +++ b/docs/interfaces/ObservableMyAccountApiClient.html @@ -0,0 +1,21 @@ +ObservableMyAccountApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Interface ObservableMyAccountApiClient

                                                                                                                                                                                                                                                          Observable-based MyAccount API client exposed by AuthService.myAccount.

                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          This is the Angular counterpart of MyAccountApiClient from @auth0/auth0-spa-js. +All methods return Observable instead of Promise.

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          interface ObservableMyAccountApiClient {
                                                                                                                                                                                                                                                              deleteAuthenticationMethod(id: string): Observable<void>;
                                                                                                                                                                                                                                                              enrollmentChallenge(
                                                                                                                                                                                                                                                                  options: EnrollmentChallengeOptions,
                                                                                                                                                                                                                                                              ): Observable<EnrollmentChallengeResponse>;
                                                                                                                                                                                                                                                              enrollmentVerify(
                                                                                                                                                                                                                                                                  options: EnrollmentVerifyOptions,
                                                                                                                                                                                                                                                              ): Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                              getAuthenticationMethod(id: string): Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                              getAuthenticationMethods(
                                                                                                                                                                                                                                                                  type?: AuthenticationMethodType,
                                                                                                                                                                                                                                                              ): Observable<AuthenticationMethod[]>;
                                                                                                                                                                                                                                                              getFactors(): Observable<Factor[]>;
                                                                                                                                                                                                                                                              updateAuthenticationMethod(
                                                                                                                                                                                                                                                                  id: string,
                                                                                                                                                                                                                                                                  data: UpdateAuthenticationMethodRequest,
                                                                                                                                                                                                                                                              ): Observable<AuthenticationMethod>;
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          deleteAuthenticationMethod +enrollmentChallenge +enrollmentVerify +getAuthenticationMethod +getAuthenticationMethods +getFactors +updateAuthenticationMethod +

                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/ObservablePasskeyApiClient.html b/docs/interfaces/ObservablePasskeyApiClient.html new file mode 100644 index 00000000..35aa610d --- /dev/null +++ b/docs/interfaces/ObservablePasskeyApiClient.html @@ -0,0 +1,11 @@ +ObservablePasskeyApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface ObservablePasskeyApiClient

                                                                                                                                                                                                                                                            Observable-based Passkey API client exposed by AuthService.passkey.

                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Wraps PasskeyApiClient from @auth0/auth0-spa-js. Both methods handle the +full WebAuthn flow internally and update Angular auth state on success. +All methods return Observable instead of Promise.

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            interface ObservablePasskeyApiClient {
                                                                                                                                                                                                                                                                login(options?: PasskeyLoginOptions): Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                signup(options: PasskeySignupOptions): Observable<TokenEndpointResponse>;
                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                            login +signup +

                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/OobEnrollmentResponse.html b/docs/interfaces/OobEnrollmentResponse.html index 98d9ec0d..f923d2e0 100644 --- a/docs/interfaces/OobEnrollmentResponse.html +++ b/docs/interfaces/OobEnrollmentResponse.html @@ -1,708 +1,16 @@ - - - - - - OobEnrollmentResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                               - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                              Interface OobEnrollmentResponse

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Response when enrolling an OOB authenticator

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - interface - OobEnrollmentResponse - {
                                                                                                                                                                                                                                                                  authenticatorType: - "oob";
                                                                                                                                                                                                                                                                  barcodeUri?: - string;
                                                                                                                                                                                                                                                                  bindingMethod?: - string;
                                                                                                                                                                                                                                                                  id?: - string;
                                                                                                                                                                                                                                                                  oobChannel: - OobChannel;
                                                                                                                                                                                                                                                                  oobCode?: - string;
                                                                                                                                                                                                                                                                  recoveryCodes?: - string[];
                                                                                                                                                                                                                                                              } -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - - -
                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - - authenticatorType - - barcodeUri? - - bindingMethod? - - id? - - oobChannel - - oobCode? - - recoveryCodes? -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - - -

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              - authenticatorType: - "oob" -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Authenticator type

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              - barcodeUri?: - string -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              URI for QR code (for Push/Guardian enrollment)

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              - bindingMethod?: - string -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Binding method (e.g., 'prompt' for user code entry)

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              - id?: - string -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Authenticator ID

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              - oobChannel: - OobChannel -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Delivery channel used

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              - oobCode?: - string -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Out-of-band code for verification

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              - recoveryCodes?: - string[] -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              - Recovery codes (generated when enrolling first MFA factor) -

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - - -

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - Member Visibility -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - - -

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - - Properties - - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - - +OobEnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface OobEnrollmentResponse

                                                                                                                                                                                                                                                                Response when enrolling an OOB authenticator

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                interface OobEnrollmentResponse {
                                                                                                                                                                                                                                                                    authenticatorType: "oob";
                                                                                                                                                                                                                                                                    barcodeUri?: string;
                                                                                                                                                                                                                                                                    bindingMethod?: string;
                                                                                                                                                                                                                                                                    id?: string;
                                                                                                                                                                                                                                                                    oobChannel: OobChannel;
                                                                                                                                                                                                                                                                    oobCode?: string;
                                                                                                                                                                                                                                                                    recoveryCodes?: string[];
                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                authenticatorType +barcodeUri? +bindingMethod? +id? +oobChannel +oobCode? +recoveryCodes? +

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                authenticatorType: "oob"

                                                                                                                                                                                                                                                                Authenticator type

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                barcodeUri?: string

                                                                                                                                                                                                                                                                URI for QR code (for Push/Guardian enrollment)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                bindingMethod?: string

                                                                                                                                                                                                                                                                Binding method (e.g., 'prompt' for user code entry)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                id?: string

                                                                                                                                                                                                                                                                Authenticator ID

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                oobChannel: OobChannel

                                                                                                                                                                                                                                                                Delivery channel used

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                oobCode?: string

                                                                                                                                                                                                                                                                Out-of-band code for verification

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                recoveryCodes?: string[]

                                                                                                                                                                                                                                                                Recovery codes (generated when enrolling first MFA factor)

                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/OtpEnrollmentResponse.html b/docs/interfaces/OtpEnrollmentResponse.html index 2dc3ea04..85ac3ed5 100644 --- a/docs/interfaces/OtpEnrollmentResponse.html +++ b/docs/interfaces/OtpEnrollmentResponse.html @@ -1,593 +1,12 @@ - - - - - - OtpEnrollmentResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                   - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                  Interface OtpEnrollmentResponse

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Response when enrolling an OTP authenticator

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - interface - OtpEnrollmentResponse - {
                                                                                                                                                                                                                                                                      authenticatorType: - "otp";
                                                                                                                                                                                                                                                                      barcodeUri: - string;
                                                                                                                                                                                                                                                                      id?: - string;
                                                                                                                                                                                                                                                                      recoveryCodes?: - string[];
                                                                                                                                                                                                                                                                      secret: - string;
                                                                                                                                                                                                                                                                  } -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - - authenticatorType - - barcodeUri - - id? - - recoveryCodes? - - secret -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  - authenticatorType: - "otp" -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Authenticator type

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  - barcodeUri: - string -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  URI for generating QR code (otpauth://...)

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  - id?: - string -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Authenticator ID

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  - recoveryCodes?: - string[] -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Recovery codes for account recovery

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  - secret: - string -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Base32-encoded secret for TOTP generation

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - Member Visibility -
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - - Properties - - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - - +OtpEnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface OtpEnrollmentResponse

                                                                                                                                                                                                                                                                    Response when enrolling an OTP authenticator

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    interface OtpEnrollmentResponse {
                                                                                                                                                                                                                                                                        authenticatorType: "otp";
                                                                                                                                                                                                                                                                        barcodeUri: string;
                                                                                                                                                                                                                                                                        id?: string;
                                                                                                                                                                                                                                                                        recoveryCodes?: string[];
                                                                                                                                                                                                                                                                        secret: string;
                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    authenticatorType +barcodeUri +id? +recoveryCodes? +secret +

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    authenticatorType: "otp"

                                                                                                                                                                                                                                                                    Authenticator type

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    barcodeUri: string

                                                                                                                                                                                                                                                                    URI for generating QR code (otpauth://...)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    id?: string

                                                                                                                                                                                                                                                                    Authenticator ID

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    recoveryCodes?: string[]

                                                                                                                                                                                                                                                                    Recovery codes for account recovery

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    secret: string

                                                                                                                                                                                                                                                                    Base32-encoded secret for TOTP generation

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/PasskeyApiClient.html b/docs/interfaces/PasskeyApiClient.html new file mode 100644 index 00000000..6750ab01 --- /dev/null +++ b/docs/interfaces/PasskeyApiClient.html @@ -0,0 +1,32 @@ +PasskeyApiClient | @auth0/auth0-angular
                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface PasskeyApiClient

                                                                                                                                                                                                                                                                      Client for Auth0 Passkey operations.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Provides 2 public methods:

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                      • signup — Register a new user with a passkey (full flow: challenge → WebAuthn → token exchange)
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      • login — Sign in with a passkey (full flow: challenge → WebAuthn → token exchange)
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      // Signup — single call handles everything
                                                                                                                                                                                                                                                                      const tokens = await auth0.passkey.signup({ email: 'user@example.com' });

                                                                                                                                                                                                                                                                      // Login — single call handles everything
                                                                                                                                                                                                                                                                      const tokens = await auth0.passkey.login();
+
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      interface PasskeyApiClient {
                                                                                                                                                                                                                                                                          login(options?: PasskeyLoginOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                          signup(options: PasskeySignupOptions): Promise<TokenEndpointResponse>;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      login +signup +

                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                      • Sign in with an existing passkey.

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Handles the full flow: requests a login challenge, triggers the browser +WebAuthn assertion ceremony, serializes the result, and exchanges it +for tokens.

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • Optionaloptions: PasskeyLoginOptions

                                                                                                                                                                                                                                                                          Optional passkey login options (optional scope/audience/realm/organization)

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                        Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                                                        A promise that resolves to the token endpoint response containing access/ID tokens

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If the challenge request fails

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If the token exchange fails

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If the user cancels the WebAuthn prompt

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                      • Register a new user with a passkey.

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Handles the full flow: requests a signup challenge, triggers the browser +WebAuthn credential creation ceremony, serializes the result, and exchanges +it for tokens.

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        Returns Promise<TokenEndpointResponse>

                                                                                                                                                                                                                                                                        A promise that resolves to the token endpoint response containing access/ID tokens

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If WebAuthn is not supported in the browser

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If the challenge request fails

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If the token exchange fails

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        If the user cancels the WebAuthn prompt

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PasskeyAuthenticationMethod.html b/docs/interfaces/PasskeyAuthenticationMethod.html new file mode 100644 index 00000000..53aa70c2 --- /dev/null +++ b/docs/interfaces/PasskeyAuthenticationMethod.html @@ -0,0 +1,16 @@ +PasskeyAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface PasskeyAuthenticationMethod

                                                                                                                                                                                                                                                                        interface PasskeyAuthenticationMethod {
                                                                                                                                                                                                                                                                            aaguid?: string;
                                                                                                                                                                                                                                                                            created_at: string;
                                                                                                                                                                                                                                                                            credential_backed_up: boolean;
                                                                                                                                                                                                                                                                            credential_device_type: "single_device" | "multi_device";
                                                                                                                                                                                                                                                                            id: string;
                                                                                                                                                                                                                                                                            identity_user_id: string;
                                                                                                                                                                                                                                                                            key_id: string;
                                                                                                                                                                                                                                                                            last_auth_at?: string;
                                                                                                                                                                                                                                                                            public_key: string;
                                                                                                                                                                                                                                                                            relying_party_id?: string;
                                                                                                                                                                                                                                                                            transports?: string[];
                                                                                                                                                                                                                                                                            type: "passkey";
                                                                                                                                                                                                                                                                            usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                            user_agent?: string;
                                                                                                                                                                                                                                                                            user_handle: string;
                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                        • AuthenticationMethodBase
                                                                                                                                                                                                                                                                          • PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        aaguid? +created_at +credential_backed_up +credential_device_type +id +identity_user_id +key_id +last_auth_at? +public_key +relying_party_id? +transports? +type +usage +user_agent? +user_handle +

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        aaguid?: string
                                                                                                                                                                                                                                                                        created_at: string
                                                                                                                                                                                                                                                                        credential_backed_up: boolean
                                                                                                                                                                                                                                                                        credential_device_type: "single_device" | "multi_device"
                                                                                                                                                                                                                                                                        id: string
                                                                                                                                                                                                                                                                        identity_user_id: string
                                                                                                                                                                                                                                                                        key_id: string
                                                                                                                                                                                                                                                                        last_auth_at?: string
                                                                                                                                                                                                                                                                        public_key: string
                                                                                                                                                                                                                                                                        relying_party_id?: string
                                                                                                                                                                                                                                                                        transports?: string[]
                                                                                                                                                                                                                                                                        type: "passkey"
                                                                                                                                                                                                                                                                        usage: ("primary" | "secondary")[]
                                                                                                                                                                                                                                                                        user_agent?: string
                                                                                                                                                                                                                                                                        user_handle: string

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/PasskeyCreationOptions.html b/docs/interfaces/PasskeyCreationOptions.html new file mode 100644 index 00000000..4abfb639 --- /dev/null +++ b/docs/interfaces/PasskeyCreationOptions.html @@ -0,0 +1,8 @@ +PasskeyCreationOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Interface PasskeyCreationOptions

                                                                                                                                                                                                                                                                          Public key credential creation options returned by signup challenges.

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          interface PasskeyCreationOptions {
                                                                                                                                                                                                                                                                              authenticatorSelection?: {
                                                                                                                                                                                                                                                                                  residentKey?: string;
                                                                                                                                                                                                                                                                                  userVerification?: string;
                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                              challenge: string;
                                                                                                                                                                                                                                                                              pubKeyCredParams: { alg: number; type: string }[];
                                                                                                                                                                                                                                                                              rp: { id: string; name: string };
                                                                                                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                                                                                                              user: { displayName: string; id: string; name: string };
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          authenticatorSelection? +challenge +pubKeyCredParams +rp +timeout? +user +

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          authenticatorSelection?: { residentKey?: string; userVerification?: string }
                                                                                                                                                                                                                                                                          challenge: string
                                                                                                                                                                                                                                                                          pubKeyCredParams: { alg: number; type: string }[]
                                                                                                                                                                                                                                                                          rp: { id: string; name: string }
                                                                                                                                                                                                                                                                          timeout?: number
                                                                                                                                                                                                                                                                          user: { displayName: string; id: string; name: string }

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PasskeyCredentialResponse.html b/docs/interfaces/PasskeyCredentialResponse.html new file mode 100644 index 00000000..fb530270 --- /dev/null +++ b/docs/interfaces/PasskeyCredentialResponse.html @@ -0,0 +1,9 @@ +PasskeyCredentialResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface PasskeyCredentialResponse

                                                                                                                                                                                                                                                                            Serialized credential response from the platform WebAuthn API. +All binary fields (rawId, clientDataJSON, etc.) must be base64url-encoded strings.

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            interface PasskeyCredentialResponse {
                                                                                                                                                                                                                                                                                authenticatorAttachment?: string;
                                                                                                                                                                                                                                                                                clientExtensionResults?: Record<string, unknown>;
                                                                                                                                                                                                                                                                                id: string;
                                                                                                                                                                                                                                                                                rawId: string;
                                                                                                                                                                                                                                                                                response: {
                                                                                                                                                                                                                                                                                    attestationObject?: string;
                                                                                                                                                                                                                                                                                    authenticatorData?: string;
                                                                                                                                                                                                                                                                                    clientDataJSON: string;
                                                                                                                                                                                                                                                                                    signature?: string;
                                                                                                                                                                                                                                                                                    userHandle?: string;
                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            authenticatorAttachment? +clientExtensionResults? +id +rawId +response +type +

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            authenticatorAttachment?: string
                                                                                                                                                                                                                                                                            clientExtensionResults?: Record<string, unknown>
                                                                                                                                                                                                                                                                            id: string
                                                                                                                                                                                                                                                                            rawId: string
                                                                                                                                                                                                                                                                            response: {
                                                                                                                                                                                                                                                                                attestationObject?: string;
                                                                                                                                                                                                                                                                                authenticatorData?: string;
                                                                                                                                                                                                                                                                                clientDataJSON: string;
                                                                                                                                                                                                                                                                                signature?: string;
                                                                                                                                                                                                                                                                                userHandle?: string;
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                            type: string

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/PasskeyEnrollmentChallengeOptions.html b/docs/interfaces/PasskeyEnrollmentChallengeOptions.html new file mode 100644 index 00000000..3dc74292 --- /dev/null +++ b/docs/interfaces/PasskeyEnrollmentChallengeOptions.html @@ -0,0 +1,4 @@ +PasskeyEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface PasskeyEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                              interface PasskeyEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                  connection?: string;
                                                                                                                                                                                                                                                                                  identity_user_id?: string;
                                                                                                                                                                                                                                                                                  type: "passkey";
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              connection? +identity_user_id? +type +

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              connection?: string
                                                                                                                                                                                                                                                                              identity_user_id?: string
                                                                                                                                                                                                                                                                              type: "passkey"

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PasskeyEnrollmentChallengeResponse.html b/docs/interfaces/PasskeyEnrollmentChallengeResponse.html new file mode 100644 index 00000000..2a4d9c7e --- /dev/null +++ b/docs/interfaces/PasskeyEnrollmentChallengeResponse.html @@ -0,0 +1,6 @@ +PasskeyEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface PasskeyEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                interface PasskeyEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                    auth_session: string;
                                                                                                                                                                                                                                                                                    authn_params_public_key: PasskeyCreationOptions;
                                                                                                                                                                                                                                                                                    id: string;
                                                                                                                                                                                                                                                                                    location: string;
                                                                                                                                                                                                                                                                                    type: "passkey";
                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                Hierarchy

                                                                                                                                                                                                                                                                                • EnrollmentChallengeBaseResponse
                                                                                                                                                                                                                                                                                  • PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                auth_session +authn_params_public_key +id +location +type +

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                auth_session: string
                                                                                                                                                                                                                                                                                authn_params_public_key: PasskeyCreationOptions
                                                                                                                                                                                                                                                                                id: string
                                                                                                                                                                                                                                                                                location: string
                                                                                                                                                                                                                                                                                type: "passkey"

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/PasskeyEnrollmentVerifyOptions.html b/docs/interfaces/PasskeyEnrollmentVerifyOptions.html new file mode 100644 index 00000000..6ffe0f3c --- /dev/null +++ b/docs/interfaces/PasskeyEnrollmentVerifyOptions.html @@ -0,0 +1,5 @@ +PasskeyEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface PasskeyEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                  interface PasskeyEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                                                                                      authn_response: PasskeyCredentialResponse;
                                                                                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                                                                                      type: "passkey";
                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                  • EnrollmentVerifyBaseOptions
                                                                                                                                                                                                                                                                                    • PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  auth_session +authn_response +location +type +

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                                                                                  authn_response: PasskeyCredentialResponse
                                                                                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                                                                                  type: "passkey"

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasskeyErrorResponse.html b/docs/interfaces/PasskeyErrorResponse.html new file mode 100644 index 00000000..b43b9cb6 --- /dev/null +++ b/docs/interfaces/PasskeyErrorResponse.html @@ -0,0 +1,4 @@ +PasskeyErrorResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface PasskeyErrorResponse

                                                                                                                                                                                                                                                                                    interface PasskeyErrorResponse {
                                                                                                                                                                                                                                                                                        error: string;
                                                                                                                                                                                                                                                                                        error_description: string;
                                                                                                                                                                                                                                                                                        message?: string;
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    error +error_description +message? +

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    error: string
                                                                                                                                                                                                                                                                                    error_description: string
                                                                                                                                                                                                                                                                                    message?: string

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/PasskeyLoginChallengeOptions.html b/docs/interfaces/PasskeyLoginChallengeOptions.html new file mode 100644 index 00000000..e7e4e49e --- /dev/null +++ b/docs/interfaces/PasskeyLoginChallengeOptions.html @@ -0,0 +1,6 @@ +PasskeyLoginChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface PasskeyLoginChallengeOptions

                                                                                                                                                                                                                                                                                      Options for requesting a passkey login challenge.

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      interface PasskeyLoginChallengeOptions {
                                                                                                                                                                                                                                                                                          organization?: string;
                                                                                                                                                                                                                                                                                          realm?: string;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      organization? +realm? +

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      organization?: string

                                                                                                                                                                                                                                                                                      Organization ID or name (scopes tokens to the organization context)

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      realm?: string

                                                                                                                                                                                                                                                                                      Database connection name (sent as realm to the API)

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PasskeyLoginChallengeResponse.html b/docs/interfaces/PasskeyLoginChallengeResponse.html new file mode 100644 index 00000000..2688411c --- /dev/null +++ b/docs/interfaces/PasskeyLoginChallengeResponse.html @@ -0,0 +1,4 @@ +PasskeyLoginChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface PasskeyLoginChallengeResponse

                                                                                                                                                                                                                                                                                        Response from a passkey login challenge request.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        interface PasskeyLoginChallengeResponse {
                                                                                                                                                                                                                                                                                            authnParamsPublicKey: PasskeyRequestOptions;
                                                                                                                                                                                                                                                                                            authSession: string;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        authnParamsPublicKey +authSession +

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        authnParamsPublicKey: PasskeyRequestOptions
                                                                                                                                                                                                                                                                                        authSession: string

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/PasskeyRequestOptions.html b/docs/interfaces/PasskeyRequestOptions.html new file mode 100644 index 00000000..5a0998dd --- /dev/null +++ b/docs/interfaces/PasskeyRequestOptions.html @@ -0,0 +1,6 @@ +PasskeyRequestOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface PasskeyRequestOptions

                                                                                                                                                                                                                                                                                          Public key credential request options returned by login challenges.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          interface PasskeyRequestOptions {
                                                                                                                                                                                                                                                                                              challenge: string;
                                                                                                                                                                                                                                                                                              rpId: string;
                                                                                                                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                                                                                                                              userVerification?: string;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          challenge +rpId +timeout? +userVerification? +

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          challenge: string
                                                                                                                                                                                                                                                                                          rpId: string
                                                                                                                                                                                                                                                                                          timeout?: number
                                                                                                                                                                                                                                                                                          userVerification?: string

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PasskeySignupChallengeResponse.html b/docs/interfaces/PasskeySignupChallengeResponse.html new file mode 100644 index 00000000..9fb403ba --- /dev/null +++ b/docs/interfaces/PasskeySignupChallengeResponse.html @@ -0,0 +1,4 @@ +PasskeySignupChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface PasskeySignupChallengeResponse

                                                                                                                                                                                                                                                                                            Response from a passkey signup challenge request.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            interface PasskeySignupChallengeResponse {
                                                                                                                                                                                                                                                                                                authnParamsPublicKey: PasskeyCreationOptions;
                                                                                                                                                                                                                                                                                                authSession: string;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            authnParamsPublicKey +authSession +

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            authnParamsPublicKey: PasskeyCreationOptions
                                                                                                                                                                                                                                                                                            authSession: string

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/PasswordAuthenticationMethod.html b/docs/interfaces/PasswordAuthenticationMethod.html new file mode 100644 index 00000000..ee30855a --- /dev/null +++ b/docs/interfaces/PasswordAuthenticationMethod.html @@ -0,0 +1,7 @@ +PasswordAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface PasswordAuthenticationMethod

                                                                                                                                                                                                                                                                                              interface PasswordAuthenticationMethod {
                                                                                                                                                                                                                                                                                                  created_at: string;
                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                  identity_user_id: string;
                                                                                                                                                                                                                                                                                                  last_password_reset?: string;
                                                                                                                                                                                                                                                                                                  type: "password";
                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                              • AuthenticationMethodBase
                                                                                                                                                                                                                                                                                                • PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              created_at +id +identity_user_id +last_password_reset? +type +usage +

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              created_at: string
                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                              identity_user_id: string
                                                                                                                                                                                                                                                                                              last_password_reset?: string
                                                                                                                                                                                                                                                                                              type: "password"
                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[]

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/PasswordEnrollmentChallengeOptions.html b/docs/interfaces/PasswordEnrollmentChallengeOptions.html new file mode 100644 index 00000000..7a85603b --- /dev/null +++ b/docs/interfaces/PasswordEnrollmentChallengeOptions.html @@ -0,0 +1,4 @@ +PasswordEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface PasswordEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                interface PasswordEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                    connection?: string;
                                                                                                                                                                                                                                                                                                    identity_user_id?: string;
                                                                                                                                                                                                                                                                                                    type: "password";
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                connection? +identity_user_id? +type +

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                connection?: string
                                                                                                                                                                                                                                                                                                identity_user_id?: string
                                                                                                                                                                                                                                                                                                type: "password"

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/PasswordEnrollmentChallengeResponse.html b/docs/interfaces/PasswordEnrollmentChallengeResponse.html new file mode 100644 index 00000000..d5a92d30 --- /dev/null +++ b/docs/interfaces/PasswordEnrollmentChallengeResponse.html @@ -0,0 +1,6 @@ +PasswordEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface PasswordEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                  interface PasswordEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                                                                                                      policy: PasswordPolicy;
                                                                                                                                                                                                                                                                                                      type: "password";
                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                  • EnrollmentChallengeBaseResponse
                                                                                                                                                                                                                                                                                                    • PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  auth_session +id +location +policy +type +

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                                                                                                  policy: PasswordPolicy
                                                                                                                                                                                                                                                                                                  type: "password"

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/PasswordEnrollmentVerifyOptions.html b/docs/interfaces/PasswordEnrollmentVerifyOptions.html new file mode 100644 index 00000000..a097dda6 --- /dev/null +++ b/docs/interfaces/PasswordEnrollmentVerifyOptions.html @@ -0,0 +1,5 @@ +PasswordEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface PasswordEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                    interface PasswordEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                        auth_session: string;
                                                                                                                                                                                                                                                                                                        location: string;
                                                                                                                                                                                                                                                                                                        new_password: string;
                                                                                                                                                                                                                                                                                                        type: "password";
                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                    • EnrollmentVerifyBaseOptions
                                                                                                                                                                                                                                                                                                      • PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    auth_session +location +new_password +type +

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    auth_session: string
                                                                                                                                                                                                                                                                                                    location: string
                                                                                                                                                                                                                                                                                                    new_password: string
                                                                                                                                                                                                                                                                                                    type: "password"

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/PhoneAuthenticationMethod.html b/docs/interfaces/PhoneAuthenticationMethod.html new file mode 100644 index 00000000..23e79615 --- /dev/null +++ b/docs/interfaces/PhoneAuthenticationMethod.html @@ -0,0 +1,10 @@ +PhoneAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface PhoneAuthenticationMethod

                                                                                                                                                                                                                                                                                                      interface PhoneAuthenticationMethod {
                                                                                                                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                          phone_number: string;
                                                                                                                                                                                                                                                                                                          preferred_authentication_method: "sms" | "voice";
                                                                                                                                                                                                                                                                                                          type: "phone";
                                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                      • AuthenticationMethodWithMetadata
                                                                                                                                                                                                                                                                                                        • PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      confirmed +created_at +id +last_auth_at? +name? +phone_number +preferred_authentication_method +type +usage +

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                      phone_number: string
                                                                                                                                                                                                                                                                                                      preferred_authentication_method: "sms" | "voice"
                                                                                                                                                                                                                                                                                                      type: "phone"
                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PhoneEnrollmentChallengeOptions.html b/docs/interfaces/PhoneEnrollmentChallengeOptions.html new file mode 100644 index 00000000..744a77b5 --- /dev/null +++ b/docs/interfaces/PhoneEnrollmentChallengeOptions.html @@ -0,0 +1,4 @@ +PhoneEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface PhoneEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                        interface PhoneEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                            phone_number: string;
                                                                                                                                                                                                                                                                                                            preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                                                                            type: "phone";
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        phone_number +preferred_authentication_method? +type +

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        phone_number: string
                                                                                                                                                                                                                                                                                                        preferred_authentication_method?: "sms" | "voice"
                                                                                                                                                                                                                                                                                                        type: "phone"

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/PhoneEnrollmentChallengeResponse.html b/docs/interfaces/PhoneEnrollmentChallengeResponse.html new file mode 100644 index 00000000..21bf96fd --- /dev/null +++ b/docs/interfaces/PhoneEnrollmentChallengeResponse.html @@ -0,0 +1,5 @@ +PhoneEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface PhoneEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                          interface PhoneEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                                                                              type: "phone";
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                          • EnrollmentChallengeBaseResponse
                                                                                                                                                                                                                                                                                                            • PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          auth_session +id +location +type +

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                                                                          type: "phone"

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PhoneEnrollmentVerifyOptions.html b/docs/interfaces/PhoneEnrollmentVerifyOptions.html new file mode 100644 index 00000000..eae34614 --- /dev/null +++ b/docs/interfaces/PhoneEnrollmentVerifyOptions.html @@ -0,0 +1,5 @@ +PhoneEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Interface PhoneEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                            interface PhoneEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                auth_session: string;
                                                                                                                                                                                                                                                                                                                location: string;
                                                                                                                                                                                                                                                                                                                otp_code: string;
                                                                                                                                                                                                                                                                                                                type: "phone";
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                            • EnrollmentVerifyBaseOptions
                                                                                                                                                                                                                                                                                                              • PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            auth_session +location +otp_code +type +

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            auth_session: string
                                                                                                                                                                                                                                                                                                            location: string
                                                                                                                                                                                                                                                                                                            otp_code: string
                                                                                                                                                                                                                                                                                                            type: "phone"

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index a5aa673e..91391163 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,531 +1,24 @@ - - - - - - PopupConfigOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                                                               - -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                              Interface PopupConfigOptions

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - interface - PopupConfigOptions - {
                                                                                                                                                                                                                                                                                                                  closePopup?: - boolean;
                                                                                                                                                                                                                                                                                                                  popup?: - any;
                                                                                                                                                                                                                                                                                                                  timeoutInSeconds?: - number;
                                                                                                                                                                                                                                                                                                              } -
                                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - - -
                                                                                                                                                                                                                                                                                                              Index
                                                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - - closePopup? - - popup? - - timeoutInSeconds? -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - - -

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                                              - closePopup?: - boolean -
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              - Controls whether the SDK automatically closes the popup - window. -

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                              • - true (default): SDK closes the popup - automatically after receiving the authorization response -
                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                              • - false: SDK does not close the popup. The caller - is responsible for closing it, including on errors. -
                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              - Setting this to false is useful when you need - full control over the popup lifecycle, such as in Chrome - extensions where closing the popup too early can terminate the - extension's service worker before authentication completes. -

                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              - When closePopup: false, you should close the - popup in a try/finally block: -

                                                                                                                                                                                                                                                                                                              - 
                                                                                                                                                                                                                                                                                                              const popup = window.open('', '_blank');
                                                                                                                                                                                                                                                                                                              try {
                                                                                                                                                                                                                                                                                                                await auth0.loginWithPopup({}, { popup, closePopup: false });
                                                                                                                                                                                                                                                                                                              } finally {
                                                                                                                                                                                                                                                                                                                popup.close();
                                                                                                                                                                                                                                                                                                              }
+PopupConfigOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                Interface PopupConfigOptions
                                                                                                                                                                                                                                                                                                                interface PopupConfigOptions {
                                                                                                                                                                                                                                                                                                                    closePopup?: boolean;
                                                                                                                                                                                                                                                                                                                    popup?: any;
                                                                                                                                                                                                                                                                                                                    timeoutInSeconds?: number;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                closePopup?
+popup?
+timeoutInSeconds?
+
                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                closePopup?: boolean
                                                                                                                                                                                                                                                                                                                Controls whether the SDK automatically closes the popup window.
                                                                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                                                                • true (default): SDK closes the popup automatically after receiving the authorization response
                                                                                                                                                                                                                                                                                                                  • 
+
                                                                                                                                                                                                                                                                                                                • false: SDK does not close the popup. The caller is responsible for closing it, including on errors.
                                                                                                                                                                                                                                                                                                                  • 
+
                                                                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                                                                Setting this to false is useful when you need full control over the popup lifecycle,
+such as in Chrome extensions where closing the popup too early can terminate the
+extension's service worker before authentication completes.
                                                                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                                                                When closePopup: false, you should close the popup in a try/finally block:
                                                                                                                                                                                                                                                                                                                
+
                                                                                                                                                                                                                                                                                                                const popup = window.open('', '_blank');
                                                                                                                                                                                                                                                                                                                try {
                                                                                                                                                                                                                                                                                                                  await auth0.loginWithPopup({}, { popup, closePopup: false });
                                                                                                                                                                                                                                                                                                                } finally {
                                                                                                                                                                                                                                                                                                                  popup.close();
                                                                                                                                                                                                                                                                                                                }
 
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-                
                                                                                                                                                                                                                                                                                                                
-                  
-                  
                                                                                                                                                                                                                                                                                                                true
+
+
                                                                                                                                                                                                                                                                                                                true
 
                                                                                                                                                                                                                                                                                                                
-                
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-              
-            
                                                                                                                                                                                                                                                                                                                
-            
                                                                                                                                                                                                                                                                                                                
-              
-              
                                                                                                                                                                                                                                                                                                                
-                popup?:
-                any
-              
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-                
                                                                                                                                                                                                                                                                                                                
-                  Accepts an already-created popup window to use. If not
-                  specified, the SDK will create its own. This may be useful for
-                  platforms like iOS that have security restrictions around when
-                  popups can be invoked (e.g. from a user click event)
-                
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-              
-            
                                                                                                                                                                                                                                                                                                                
-            
                                                                                                                                                                                                                                                                                                                
-              
-              
                                                                                                                                                                                                                                                                                                                
-                timeoutInSeconds?:
-                number
-              
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-                
                                                                                                                                                                                                                                                                                                                
-                  The number of seconds to wait for a popup response before
-                  throwing a timeout error. Defaults to 60s
-                
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-              
-            
                                                                                                                                                                                                                                                                                                                
-          
                                                                                                                                                                                                                                                                                                                
-        
                                                                                                                                                                                                                                                                                                                
-      
                                                                                                                                                                                                                                                                                                                
-      
                                                                                                                                                                                                                                                                                                                
-        
                                                                                                                                                                                                                                                                                                                
-          
                                                                                                                                                                                                                                                                                                                
-            
                                                                                                                                                                                                                                                                                                                
-              
-                
-                
                                                                                                                                                                                                                                                                                                                Settings
                                                                                                                                                                                                                                                                                                                
-                                                                                                                                                                                                                                                                                                                              
-              
                                                                                                                                                                                                                                                                                                                
-                
                                                                                                                                                                                                                                                                                                                
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                                                  
-                    
                                                                                                                                                                                                                                                                                                                • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                  • 
-                    
                                                                                                                                                                                                                                                                                                                • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                  • 
-                    
                                                                                                                                                                                                                                                                                                                • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                  • 
-                  
                                                                                                                                                                                                                                                                                                                
-                
                                                                                                                                                                                                                                                                                                                
-                
                                                                                                                                                                                                                                                                                                                
-                  
-                
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-            
                                                                                                                                                                                                                                                                                                                
-          
                                                                                                                                                                                                                                                                                                                
-          
                                                                                                                                                                                                                                                                                                                
-            
-              
-              
                                                                                                                                                                                                                                                                                                                On This Page
                                                                                                                                                                                                                                                                                                                
-                                                                                                                                                                                                                                                                                                                            
-            
                                                                                                                                                                                                                                                                                                                
-              
                                                                                                                                                                                                                                                                                                                
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                                                                                                                                                                
-            
                                                                                                                                                                                                                                                                                                                
-          
                                                                                                                                                                                                                                                                                                                
-        
                                                                                                                                                                                                                                                                                                                
-        
                                                                                                                                                                                                                                                                                                                
-          
-        
                                                                                                                                                                                                                                                                                                                
-      
                                                                                                                                                                                                                                                                                                                
-    
                                                                                                                                                                                                                                                                                                                
-    
                                                                                                                                                                                                                                                                                                                
-    
                                                                                                                                                                                                                                                                                                                
-  
-
+
+
                                                                                                                                                                                                                                                                                                                popup?: any

                                                                                                                                                                                                                                                                                                                Accepts an already-created popup window to use. If not specified, the SDK +will create its own. This may be useful for platforms like iOS that have +security restrictions around when popups can be invoked (e.g. from a user click event)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                timeoutInSeconds?: number

                                                                                                                                                                                                                                                                                                                The number of seconds to wait for a popup response before +throwing a timeout error. Defaults to 60s

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 5fe90983..8ddd528d 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,425 +1,4 @@ - - - - - - PopupLoginOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                   - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                  Interface PopupLoginOptions

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - interface - PopupLoginOptions - {
                                                                                                                                                                                                                                                                                                                      authorizationParams?: - AuthorizationParams;
                                                                                                                                                                                                                                                                                                                  } -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  - Hierarchy (View Summary) -

                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - - -
                                                                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - - authorizationParams? -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                  - authorizationParams?: - AuthorizationParams -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  - URL parameters that will be sent back to the Authorization - Server. This can be known parameters defined by Auth0 or - custom parameters that you define. -

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - Member Visibility -
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - - Properties - - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  - - +PopupLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface PopupLoginOptions

                                                                                                                                                                                                                                                                                                                    interface PopupLoginOptions {
                                                                                                                                                                                                                                                                                                                        authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    authorizationParams? +

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    authorizationParams?: AuthorizationParams

                                                                                                                                                                                                                                                                                                                    URL parameters that will be sent back to the Authorization Server. This can be known parameters +defined by Auth0 or custom parameters that you define.

                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/PushNotificationAuthenticationMethod.html b/docs/interfaces/PushNotificationAuthenticationMethod.html new file mode 100644 index 00000000..293c3a53 --- /dev/null +++ b/docs/interfaces/PushNotificationAuthenticationMethod.html @@ -0,0 +1,8 @@ +PushNotificationAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface PushNotificationAuthenticationMethod

                                                                                                                                                                                                                                                                                                                      interface PushNotificationAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                          confirmed: boolean;
                                                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                          last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                          type: "push-notification";
                                                                                                                                                                                                                                                                                                                          usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                      • AuthenticationMethodWithMetadata
                                                                                                                                                                                                                                                                                                                        • PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      confirmed +created_at +id +last_auth_at? +name? +type +usage +

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      confirmed: boolean
                                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                                      id: string
                                                                                                                                                                                                                                                                                                                      last_auth_at?: string
                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                      type: "push-notification"
                                                                                                                                                                                                                                                                                                                      usage: ("primary" | "secondary")[]

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/PushNotificationEnrollmentChallengeOptions.html b/docs/interfaces/PushNotificationEnrollmentChallengeOptions.html new file mode 100644 index 00000000..b85c7824 --- /dev/null +++ b/docs/interfaces/PushNotificationEnrollmentChallengeOptions.html @@ -0,0 +1,2 @@ +PushNotificationEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface PushNotificationEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                        interface PushNotificationEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                            type: "push-notification";
                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        type +

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        type: "push-notification"

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html b/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html new file mode 100644 index 00000000..d9dcfffe --- /dev/null +++ b/docs/interfaces/PushNotificationEnrollmentChallengeResponse.html @@ -0,0 +1,7 @@ +PushNotificationEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface PushNotificationEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                          interface PushNotificationEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                              auth_session: string;
                                                                                                                                                                                                                                                                                                                              barcode_uri: string;
                                                                                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                                                                                              location: string;
                                                                                                                                                                                                                                                                                                                              manual_input_code?: string;
                                                                                                                                                                                                                                                                                                                              type: "push-notification";
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                          • EnrollmentChallengeBaseResponse
                                                                                                                                                                                                                                                                                                                            • PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          auth_session +barcode_uri +id +location +manual_input_code? +type +

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          auth_session: string
                                                                                                                                                                                                                                                                                                                          barcode_uri: string
                                                                                                                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                                                                                                                          location: string
                                                                                                                                                                                                                                                                                                                          manual_input_code?: string
                                                                                                                                                                                                                                                                                                                          type: "push-notification"

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html b/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html new file mode 100644 index 00000000..42e8d7d9 --- /dev/null +++ b/docs/interfaces/PushNotificationEnrollmentVerifyOptions.html @@ -0,0 +1,4 @@ +PushNotificationEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Interface PushNotificationEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                            interface PushNotificationEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                auth_session: string;
                                                                                                                                                                                                                                                                                                                                location: string;
                                                                                                                                                                                                                                                                                                                                type: "push-notification";
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                            • EnrollmentVerifyBaseOptions
                                                                                                                                                                                                                                                                                                                              • PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            auth_session +location +type +

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            auth_session: string
                                                                                                                                                                                                                                                                                                                            location: string
                                                                                                                                                                                                                                                                                                                            type: "push-notification"

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/RecoveryCodeAuthenticationMethod.html b/docs/interfaces/RecoveryCodeAuthenticationMethod.html new file mode 100644 index 00000000..c7ccf7b7 --- /dev/null +++ b/docs/interfaces/RecoveryCodeAuthenticationMethod.html @@ -0,0 +1,7 @@ +RecoveryCodeAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface RecoveryCodeAuthenticationMethod

                                                                                                                                                                                                                                                                                                                              interface RecoveryCodeAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                  confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                  created_at: string;
                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                  last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                  type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                              • Omit<AuthenticationMethodWithMetadata, "name">
                                                                                                                                                                                                                                                                                                                                • RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              confirmed +created_at +id +last_auth_at? +type +usage +

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              confirmed: boolean
                                                                                                                                                                                                                                                                                                                              created_at: string
                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                              last_auth_at?: string
                                                                                                                                                                                                                                                                                                                              type: "recovery-code"
                                                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[]

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html b/docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html new file mode 100644 index 00000000..c6b59529 --- /dev/null +++ b/docs/interfaces/RecoveryCodeEnrollmentChallengeOptions.html @@ -0,0 +1,2 @@ +RecoveryCodeEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface RecoveryCodeEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                interface RecoveryCodeEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                    type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                type +

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                type: "recovery-code"

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html b/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html new file mode 100644 index 00000000..a48c412c --- /dev/null +++ b/docs/interfaces/RecoveryCodeEnrollmentChallengeResponse.html @@ -0,0 +1,6 @@ +RecoveryCodeEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface RecoveryCodeEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                  interface RecoveryCodeEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                                                                                                                                      recovery_code: string;
                                                                                                                                                                                                                                                                                                                                      type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                  • EnrollmentChallengeBaseResponse
                                                                                                                                                                                                                                                                                                                                    • RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  auth_session +id +location +recovery_code +type +

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                                                                                                                                  recovery_code: string
                                                                                                                                                                                                                                                                                                                                  type: "recovery-code"

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html b/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html new file mode 100644 index 00000000..52b7e06f --- /dev/null +++ b/docs/interfaces/RecoveryCodeEnrollmentVerifyOptions.html @@ -0,0 +1,4 @@ +RecoveryCodeEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Interface RecoveryCodeEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                    interface RecoveryCodeEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                        auth_session: string;
                                                                                                                                                                                                                                                                                                                                        location: string;
                                                                                                                                                                                                                                                                                                                                        type: "recovery-code";
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                    • EnrollmentVerifyBaseOptions
                                                                                                                                                                                                                                                                                                                                      • RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    auth_session +location +type +

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    auth_session: string
                                                                                                                                                                                                                                                                                                                                    location: string
                                                                                                                                                                                                                                                                                                                                    type: "recovery-code"

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index 921ee5e8..c8d681a7 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -1,764 +1,25 @@ - - - - - - RedirectConnectAccountOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                       - -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                      Interface RedirectConnectAccountOptions<TAppState>

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - interface - RedirectConnectAccountOptions<TAppState - = - any> - {
                                                                                                                                                                                                                                                                                                                                          appState?: - TAppState;
                                                                                                                                                                                                                                                                                                                                          authorization_params?: - AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                          connection: - string;
                                                                                                                                                                                                                                                                                                                                          openUrl?: - (url: - string) - => - Promise<void>;
                                                                                                                                                                                                                                                                                                                                          redirectUri?: - string;
                                                                                                                                                                                                                                                                                                                                          scopes?: - string[];
                                                                                                                                                                                                                                                                                                                                      } -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                      • - TAppState = - any -
                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - - -
                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - - appState? - - authorization_params? - - connection - - openUrl? - - redirectUri? - - scopes? -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                      - appState?: - TAppState -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      - Optional application state to persist through the transaction. -

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      - - 
                                                                                                                                                                                                                                                                                                                                      await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                        connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                                                                        appState: { returnTo: '/settings' }
                                                                                                                                                                                                                                                                                                                                      });
+RedirectConnectAccountOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                        Interface RedirectConnectAccountOptions<TAppState>
                                                                                                                                                                                                                                                                                                                                        interface RedirectConnectAccountOptions<TAppState = any> {
                                                                                                                                                                                                                                                                                                                                            appState?: TAppState;
                                                                                                                                                                                                                                                                                                                                            authorization_params?: AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                            connection: string;
                                                                                                                                                                                                                                                                                                                                            openUrl?: (url: string) => Promise<void>;
                                                                                                                                                                                                                                                                                                                                            redirectUri?: string;
                                                                                                                                                                                                                                                                                                                                            scopes?: string[];
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        Type Parameters
                                                                                                                                                                                                                                                                                                                                        • TAppState = any
                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        appState?
+authorization_params?
+connection
+openUrl?
+redirectUri?
+scopes?
+
                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        appState?: TAppState
                                                                                                                                                                                                                                                                                                                                        Optional application state to persist through the transaction.
                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                        await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                          connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                                                                          appState: { returnTo: '/settings' }
                                                                                                                                                                                                                                                                                                                                        });
 
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
-            
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-              
-              
                                                                                                                                                                                                                                                                                                                                        
-                authorization_params?:
-                AuthorizationParams
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        Additional authorization parameters for the request.
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                  
-                  
                                                                                                                                                                                                                                                                                                                                        await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                          connection: 'github',
                                                                                                                                                                                                                                                                                                                                          authorization_params: {
                                                                                                                                                                                                                                                                                                                                            audience: 'https://api.github.com'
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                        });
+
+
                                                                                                                                                                                                                                                                                                                                        authorization_params?: AuthorizationParams
                                                                                                                                                                                                                                                                                                                                        Additional authorization parameters for the request.
                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                        await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                          connection: 'github',
                                                                                                                                                                                                                                                                                                                                          authorization_params: {
                                                                                                                                                                                                                                                                                                                                            audience: 'https://api.github.com'
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                        });
 
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
-            
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-              
-              
                                                                                                                                                                                                                                                                                                                                        
-                connection:
-                string
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                  The name of the connection to link (e.g. 'google-oauth2').
-                
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
-            
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-              
-              
                                                                                                                                                                                                                                                                                                                                        
-                openUrl?:
-                (url:
-                string)
-                =>
-                Promise<void>
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        Optional function to handle the redirect URL.
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                  
-                  
                                                                                                                                                                                                                                                                                                                                        await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                          connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                                                                          openUrl: async (url) => { myBrowserApi.open(url); }
                                                                                                                                                                                                                                                                                                                                        });
+
+
                                                                                                                                                                                                                                                                                                                                        connection: string
                                                                                                                                                                                                                                                                                                                                        The name of the connection to link (e.g. 'google-oauth2').
                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                        openUrl?: (url: string) => Promise<void>
                                                                                                                                                                                                                                                                                                                                        Optional function to handle the redirect URL.
                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                        await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                          connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                                                                          openUrl: async (url) => { myBrowserApi.open(url); }
                                                                                                                                                                                                                                                                                                                                        });
 
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
-            
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-              
-              
                                                                                                                                                                                                                                                                                                                                        
-                redirectUri?:
-                string
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        The URI to redirect back to after connecting the account.
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
-            
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-              
-              
                                                                                                                                                                                                                                                                                                                                        
-                scopes?:
-                string[]
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                  Array of scopes to request from the Identity Provider during
-                  the connect account flow.
-                
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                  
-                  
                                                                                                                                                                                                                                                                                                                                        await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                          connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                                                                          scopes: ['https://www.googleapis.com/auth/calendar']
                                                                                                                                                                                                                                                                                                                                        });
+
+
                                                                                                                                                                                                                                                                                                                                        redirectUri?: string
                                                                                                                                                                                                                                                                                                                                        The URI to redirect back to after connecting the account.
                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                        scopes?: string[]
                                                                                                                                                                                                                                                                                                                                        Array of scopes to request from the Identity Provider during the connect account flow.
                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                        await auth0.connectAccountWithRedirect({
                                                                                                                                                                                                                                                                                                                                          connection: 'google-oauth2',
                                                                                                                                                                                                                                                                                                                                          scopes: ['https://www.googleapis.com/auth/calendar']
                                                                                                                                                                                                                                                                                                                                        });
 
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-              
-            
                                                                                                                                                                                                                                                                                                                                        
-          
                                                                                                                                                                                                                                                                                                                                        
-        
                                                                                                                                                                                                                                                                                                                                        
-      
                                                                                                                                                                                                                                                                                                                                        
-      
                                                                                                                                                                                                                                                                                                                                        
-        
                                                                                                                                                                                                                                                                                                                                        
-          
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-              
-                
-                
                                                                                                                                                                                                                                                                                                                                        Settings
                                                                                                                                                                                                                                                                                                                                        
-                                                                                                                                                                                                                                                                                                                                                      
-              
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                                                                          
-                    
                                                                                                                                                                                                                                                                                                                                        • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                          • 
-                    
                                                                                                                                                                                                                                                                                                                                        • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                          • 
-                    
                                                                                                                                                                                                                                                                                                                                        • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                          • 
-                  
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                        
-                  
-                
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-          
                                                                                                                                                                                                                                                                                                                                        
-          
                                                                                                                                                                                                                                                                                                                                        
-            
-              
-              
                                                                                                                                                                                                                                                                                                                                        On This Page
                                                                                                                                                                                                                                                                                                                                        
-                                                                                                                                                                                                                                                                                                                                                    
-            
                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                        
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                        
-          
                                                                                                                                                                                                                                                                                                                                        
-        
                                                                                                                                                                                                                                                                                                                                        
-        
                                                                                                                                                                                                                                                                                                                                        
-          
-        
                                                                                                                                                                                                                                                                                                                                        
-      
                                                                                                                                                                                                                                                                                                                                        
-    
                                                                                                                                                                                                                                                                                                                                        
-    
                                                                                                                                                                                                                                                                                                                                        
-    
                                                                                                                                                                                                                                                                                                                                        
-  
-
+
+

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 7c4b0a52..75d80b81 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,676 +1,16 @@ - - - - - - RedirectLoginOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                                                           - -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                                                          Interface RedirectLoginOptions<TAppState>

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - interface - RedirectLoginOptions<TAppState> - {
                                                                                                                                                                                                                                                                                                                                              appState?: - TAppState;
                                                                                                                                                                                                                                                                                                                                              authorizationParams?: - AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                              fragment?: - string;
                                                                                                                                                                                                                                                                                                                                              openUrl?: - (url: - string) - => - void - | - Promise<void>;
                                                                                                                                                                                                                                                                                                                                          } -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          • - TAppState -
                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          • - Omit<SPARedirectLoginOptions<TAppState>, - "onRedirect"> -
                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                            • - RedirectLoginOptions -
                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - - -
                                                                                                                                                                                                                                                                                                                                          Index
                                                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - - appState? - - authorizationParams? - - fragment? - - openUrl? -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - - -

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          - appState?: - TAppState -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Used to store state before doing the redirect

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          - authorizationParams?: - AuthorizationParams -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          - URL parameters that will be sent back to the Authorization - Server. This can be known parameters defined by Auth0 or - custom parameters that you define. -

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          - fragment?: - string -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Used to add to the URL fragment before redirecting

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                          - openUrl?: - (url: - string) - => - void - | - Promise<void> -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          - Used to control the redirect and not rely on the SDK to do the - actual redirect. -

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          - - 
                                                                                                                                                                                                                                                                                                                                          const client = new Auth0Client({
                                                                                                                                                                                                                                                                                                                                            openUrl(url) {
                                                                                                                                                                                                                                                                                                                                              window.location.replace(url);
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                          });
+RedirectLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                            Interface RedirectLoginOptions<TAppState>
                                                                                                                                                                                                                                                                                                                                            interface RedirectLoginOptions<TAppState> {
                                                                                                                                                                                                                                                                                                                                                appState?: TAppState;
                                                                                                                                                                                                                                                                                                                                                authorizationParams?: AuthorizationParams;
                                                                                                                                                                                                                                                                                                                                                fragment?: string;
                                                                                                                                                                                                                                                                                                                                                openUrl?: (url: string) => void | Promise<void>;
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                                                                                                                                                            • TAppState
                                                                                                                                                                                                                                                                                                                                            Hierarchy
                                                                                                                                                                                                                                                                                                                                            • Omit<SPARedirectLoginOptions<TAppState>, "onRedirect">
                                                                                                                                                                                                                                                                                                                                              • RedirectLoginOptions
                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                            appState?
+authorizationParams?
+fragment?
+openUrl?
+
                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                            appState?: TAppState
                                                                                                                                                                                                                                                                                                                                            Used to store state before doing the redirect
                                                                                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                                                                                            authorizationParams?: AuthorizationParams
                                                                                                                                                                                                                                                                                                                                            URL parameters that will be sent back to the Authorization Server. This can be known parameters
+defined by Auth0 or custom parameters that you define.
                                                                                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                                                                                            fragment?: string
                                                                                                                                                                                                                                                                                                                                            Used to add to the URL fragment before redirecting
                                                                                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                                                                                            openUrl?: (url: string) => void | Promise<void>
                                                                                                                                                                                                                                                                                                                                            Used to control the redirect and not rely on the SDK to do the actual redirect.
                                                                                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                                                                                            const client = new Auth0Client({
                                                                                                                                                                                                                                                                                                                                              openUrl(url) {
                                                                                                                                                                                                                                                                                                                                                window.location.replace(url);
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                            });
 
                                                                                                                                                                                                                                                                                                                                            
-                
                                                                                                                                                                                                                                                                                                                                            
-                
                                                                                                                                                                                                                                                                                                                                            
-                  
-                  
                                                                                                                                                                                                                                                                                                                                            import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                                                                                                            const client = new Auth0Client({
                                                                                                                                                                                                                                                                                                                                              async openUrl(url) {
                                                                                                                                                                                                                                                                                                                                                await Browser.open({ url });
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                            });
+
+
                                                                                                                                                                                                                                                                                                                                            import { Browser } from '@capacitor/browser';

                                                                                                                                                                                                                                                                                                                                            const client = new Auth0Client({
                                                                                                                                                                                                                                                                                                                                              async openUrl(url) {
                                                                                                                                                                                                                                                                                                                                                await Browser.open({ url });
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                            });
 
                                                                                                                                                                                                                                                                                                                                            
-                
                                                                                                                                                                                                                                                                                                                                            
-              
                                                                                                                                                                                                                                                                                                                                            
-              
-            
                                                                                                                                                                                                                                                                                                                                            
-          
                                                                                                                                                                                                                                                                                                                                            
-        
                                                                                                                                                                                                                                                                                                                                            
-      
                                                                                                                                                                                                                                                                                                                                            
-      
                                                                                                                                                                                                                                                                                                                                            
-        
                                                                                                                                                                                                                                                                                                                                            
-          
                                                                                                                                                                                                                                                                                                                                            
-            
                                                                                                                                                                                                                                                                                                                                            
-              
-                
-                
                                                                                                                                                                                                                                                                                                                                            Settings
                                                                                                                                                                                                                                                                                                                                            
-                                                                                                                                                                                                                                                                                                                                                          
-              
                                                                                                                                                                                                                                                                                                                                            
-                
                                                                                                                                                                                                                                                                                                                                            
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                                                                              
-                    
                                                                                                                                                                                                                                                                                                                                            • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                              • 
-                    
                                                                                                                                                                                                                                                                                                                                            • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                              • 
-                    
                                                                                                                                                                                                                                                                                                                                            • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                              • 
-                  
                                                                                                                                                                                                                                                                                                                                            
-                
                                                                                                                                                                                                                                                                                                                                            
-                
                                                                                                                                                                                                                                                                                                                                            
-                  
-                
                                                                                                                                                                                                                                                                                                                                            
-              
                                                                                                                                                                                                                                                                                                                                            
-            
                                                                                                                                                                                                                                                                                                                                            
-          
                                                                                                                                                                                                                                                                                                                                            
-          
                                                                                                                                                                                                                                                                                                                                            
-            
-              
-              
                                                                                                                                                                                                                                                                                                                                            On This Page
                                                                                                                                                                                                                                                                                                                                            
-                                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                            
-              
                                                                                                                                                                                                                                                                                                                                            
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                                                                                                                                                                                            
-            
                                                                                                                                                                                                                                                                                                                                            
-          
                                                                                                                                                                                                                                                                                                                                            
-        
                                                                                                                                                                                                                                                                                                                                            
-        
                                                                                                                                                                                                                                                                                                                                            
-          
-        
                                                                                                                                                                                                                                                                                                                                            
-      
                                                                                                                                                                                                                                                                                                                                            
-    
                                                                                                                                                                                                                                                                                                                                            
-    
                                                                                                                                                                                                                                                                                                                                            
-    
                                                                                                                                                                                                                                                                                                                                            
-  
-
+
+

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/TotpAuthenticationMethod.html b/docs/interfaces/TotpAuthenticationMethod.html new file mode 100644 index 00000000..9cb222e9 --- /dev/null +++ b/docs/interfaces/TotpAuthenticationMethod.html @@ -0,0 +1,8 @@ +TotpAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Interface TotpAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                              interface TotpAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                  confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                  created_at: string;
                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                  last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                                                                                                  type: "totp";
                                                                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                              • AuthenticationMethodWithMetadata
                                                                                                                                                                                                                                                                                                                                                • TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              confirmed +created_at +id +last_auth_at? +name? +type +usage +

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              confirmed: boolean
                                                                                                                                                                                                                                                                                                                                              created_at: string
                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                              last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                              name?: string
                                                                                                                                                                                                                                                                                                                                              type: "totp"
                                                                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[]

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/TotpEnrollmentChallengeOptions.html b/docs/interfaces/TotpEnrollmentChallengeOptions.html new file mode 100644 index 00000000..3d5ac35d --- /dev/null +++ b/docs/interfaces/TotpEnrollmentChallengeOptions.html @@ -0,0 +1,2 @@ +TotpEnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Interface TotpEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                interface TotpEnrollmentChallengeOptions {
                                                                                                                                                                                                                                                                                                                                                    type: "totp";
                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                type +

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                type: "totp"

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/TotpEnrollmentChallengeResponse.html b/docs/interfaces/TotpEnrollmentChallengeResponse.html new file mode 100644 index 00000000..61067fa9 --- /dev/null +++ b/docs/interfaces/TotpEnrollmentChallengeResponse.html @@ -0,0 +1,7 @@ +TotpEnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface TotpEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                  interface TotpEnrollmentChallengeResponse {
                                                                                                                                                                                                                                                                                                                                                      auth_session: string;
                                                                                                                                                                                                                                                                                                                                                      barcode_uri: string;
                                                                                                                                                                                                                                                                                                                                                      id: string;
                                                                                                                                                                                                                                                                                                                                                      location: string;
                                                                                                                                                                                                                                                                                                                                                      manual_input_code?: string;
                                                                                                                                                                                                                                                                                                                                                      type: "totp";
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                                                                                                  • EnrollmentChallengeBaseResponse
                                                                                                                                                                                                                                                                                                                                                    • TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  auth_session +barcode_uri +id +location +manual_input_code? +type +

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  auth_session: string
                                                                                                                                                                                                                                                                                                                                                  barcode_uri: string
                                                                                                                                                                                                                                                                                                                                                  id: string
                                                                                                                                                                                                                                                                                                                                                  location: string
                                                                                                                                                                                                                                                                                                                                                  manual_input_code?: string
                                                                                                                                                                                                                                                                                                                                                  type: "totp"

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/TotpEnrollmentVerifyOptions.html b/docs/interfaces/TotpEnrollmentVerifyOptions.html new file mode 100644 index 00000000..64460c17 --- /dev/null +++ b/docs/interfaces/TotpEnrollmentVerifyOptions.html @@ -0,0 +1,5 @@ +TotpEnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Interface TotpEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                    interface TotpEnrollmentVerifyOptions {
                                                                                                                                                                                                                                                                                                                                                        auth_session: string;
                                                                                                                                                                                                                                                                                                                                                        location: string;
                                                                                                                                                                                                                                                                                                                                                        otp_code: string;
                                                                                                                                                                                                                                                                                                                                                        type: "totp";
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                    • EnrollmentVerifyBaseOptions
                                                                                                                                                                                                                                                                                                                                                      • TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    auth_session +location +otp_code +type +

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    auth_session: string
                                                                                                                                                                                                                                                                                                                                                    location: string
                                                                                                                                                                                                                                                                                                                                                    otp_code: string
                                                                                                                                                                                                                                                                                                                                                    type: "totp"

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/UpdateAuthenticationMethodRequest.html b/docs/interfaces/UpdateAuthenticationMethodRequest.html new file mode 100644 index 00000000..f83409f1 --- /dev/null +++ b/docs/interfaces/UpdateAuthenticationMethodRequest.html @@ -0,0 +1,4 @@ +UpdateAuthenticationMethodRequest | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Interface UpdateAuthenticationMethodRequest

                                                                                                                                                                                                                                                                                                                                                      interface UpdateAuthenticationMethodRequest {
                                                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                                                          preferred_authentication_method?: "sms" | "voice";
                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      name? +preferred_authentication_method? +

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                      preferred_authentication_method?: "sms" | "voice"

                                                                                                                                                                                                                                                                                                                                                      Only valid when updating a phone authentication method.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/VerifyParams.html b/docs/interfaces/VerifyParams.html index 8ed60d30..1ce33c90 100644 --- a/docs/interfaces/VerifyParams.html +++ b/docs/interfaces/VerifyParams.html @@ -1,603 +1,18 @@ - - - - - - VerifyParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                        Interface VerifyParams

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Parameters for verifying an MFA challenge.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        - The grant_type is automatically inferred from which verification - field is provided: -

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • otp field → MFA-OTP grant type
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        • oobCode field → MFA-OOB grant type
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        • - recoveryCode field → MFA-RECOVERY-CODE grant type -
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - interface - VerifyParams - {
                                                                                                                                                                                                                                                                                                                                                            bindingCode?: - string;
                                                                                                                                                                                                                                                                                                                                                            mfaToken: - string;
                                                                                                                                                                                                                                                                                                                                                            oobCode?: - string;
                                                                                                                                                                                                                                                                                                                                                            otp?: - string;
                                                                                                                                                                                                                                                                                                                                                            recoveryCode?: - string;
                                                                                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - - -
                                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - - bindingCode? - - mfaToken - - oobCode? - - otp? - - recoveryCode? -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        - bindingCode?: - string -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Binding code (for OOB challenges with binding)

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        - mfaToken: - string -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        MFA token from challenge flow

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        - oobCode?: - string -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Out-of-band code (for OOB challenges)

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        - otp?: - string -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        One-time password (for OTP challenges)

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        - recoveryCode?: - string -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Recovery code (for recovery code verification)

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - - Properties - - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        - - +VerifyParams | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface VerifyParams

                                                                                                                                                                                                                                                                                                                                                          Parameters for verifying an MFA challenge.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          The grant_type is automatically inferred from which verification field is provided:

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • otp field → MFA-OTP grant type
                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                          • oobCode field → MFA-OOB grant type
                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                          • recoveryCode field → MFA-RECOVERY-CODE grant type
                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          interface VerifyParams {
                                                                                                                                                                                                                                                                                                                                                              bindingCode?: string;
                                                                                                                                                                                                                                                                                                                                                              mfaToken: string;
                                                                                                                                                                                                                                                                                                                                                              oobCode?: string;
                                                                                                                                                                                                                                                                                                                                                              otp?: string;
                                                                                                                                                                                                                                                                                                                                                              recoveryCode?: string;
                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          bindingCode? +mfaToken +oobCode? +otp? +recoveryCode? +

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          bindingCode?: string

                                                                                                                                                                                                                                                                                                                                                          Binding code (for OOB challenges with binding)

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          mfaToken: string

                                                                                                                                                                                                                                                                                                                                                          MFA token from challenge flow

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          oobCode?: string

                                                                                                                                                                                                                                                                                                                                                          Out-of-band code (for OOB challenges)

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          otp?: string

                                                                                                                                                                                                                                                                                                                                                          One-time password (for OTP challenges)

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          recoveryCode?: string

                                                                                                                                                                                                                                                                                                                                                          Recovery code (for recovery code verification)

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html b/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html new file mode 100644 index 00000000..0ba694c5 --- /dev/null +++ b/docs/interfaces/WebAuthnPlatformAuthenticationMethod.html @@ -0,0 +1,10 @@ +WebAuthnPlatformAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Interface WebAuthnPlatformAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                            interface WebAuthnPlatformAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                created_at: string;
                                                                                                                                                                                                                                                                                                                                                                id: string;
                                                                                                                                                                                                                                                                                                                                                                key_id?: string;
                                                                                                                                                                                                                                                                                                                                                                last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                name?: string;
                                                                                                                                                                                                                                                                                                                                                                public_key?: string;
                                                                                                                                                                                                                                                                                                                                                                type: "webauthn-platform";
                                                                                                                                                                                                                                                                                                                                                                usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                            • WebAuthnAuthenticationMethodBase
                                                                                                                                                                                                                                                                                                                                                              • WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            confirmed +created_at +id +key_id? +last_auth_at? +name? +public_key? +type +usage +

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                            created_at: string
                                                                                                                                                                                                                                                                                                                                                            id: string
                                                                                                                                                                                                                                                                                                                                                            key_id?: string
                                                                                                                                                                                                                                                                                                                                                            last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                            name?: string
                                                                                                                                                                                                                                                                                                                                                            public_key?: string
                                                                                                                                                                                                                                                                                                                                                            type: "webauthn-platform"
                                                                                                                                                                                                                                                                                                                                                            usage: ("primary" | "secondary")[]

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html b/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html new file mode 100644 index 00000000..855e3f07 --- /dev/null +++ b/docs/interfaces/WebAuthnRoamingAuthenticationMethod.html @@ -0,0 +1,10 @@ +WebAuthnRoamingAuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Interface WebAuthnRoamingAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                              interface WebAuthnRoamingAuthenticationMethod {
                                                                                                                                                                                                                                                                                                                                                                  confirmed: boolean;
                                                                                                                                                                                                                                                                                                                                                                  created_at: string;
                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                  key_id?: string;
                                                                                                                                                                                                                                                                                                                                                                  last_auth_at?: string;
                                                                                                                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                                                                                                                  public_key?: string;
                                                                                                                                                                                                                                                                                                                                                                  type: "webauthn-roaming";
                                                                                                                                                                                                                                                                                                                                                                  usage: ("primary" | "secondary")[];
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Hierarchy

                                                                                                                                                                                                                                                                                                                                                              • WebAuthnAuthenticationMethodBase
                                                                                                                                                                                                                                                                                                                                                                • WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              confirmed +created_at +id +key_id? +last_auth_at? +name? +public_key? +type +usage +

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              confirmed: boolean
                                                                                                                                                                                                                                                                                                                                                              created_at: string
                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                              key_id?: string
                                                                                                                                                                                                                                                                                                                                                              last_auth_at?: string
                                                                                                                                                                                                                                                                                                                                                              name?: string
                                                                                                                                                                                                                                                                                                                                                              public_key?: string
                                                                                                                                                                                                                                                                                                                                                              type: "webauthn-roaming"
                                                                                                                                                                                                                                                                                                                                                              usage: ("primary" | "secondary")[]

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/modules.html b/docs/modules.html index eeea825f..8ed27d96 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,2642 +1 @@ - - - - - - @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  Enumerations

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - HttpMethod -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ResponseType -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AbstractNavigator -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Auth0ClientFactory -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthClientConfig -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthenticationError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthGuard -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthHttpInterceptor -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthModule -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthService -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthState -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ConnectError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Fetcher -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - GenericError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - InMemoryCache -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - LocalStorageCache -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaChallengeError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaEnrollmentError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaEnrollmentFactorsError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaListAuthenticatorsError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaRequiredError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaVerifyError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MissingRefreshTokenError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - PopupCancelledError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - PopupOpenError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - PopupTimeoutError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - TimeoutError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - UseDpopNonceError -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - User -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AppState -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthConfig -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Authenticator -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthorizationParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ChallengeAuthenticatorParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ChallengeResponse -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollEmailParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollmentFactor -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollOtpParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollPushParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollSmsParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollVoiceParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - GetTokenSilentlyOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - GetTokenWithPopupOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - HttpInterceptorConfig -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - HttpInterceptorRouteConfig -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ICache -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - IdToken -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - LogoutOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ObservableMfaApiClient -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - OobEnrollmentResponse -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - OtpEnrollmentResponse -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - PopupConfigOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - PopupLoginOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - RedirectConnectAccountOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - RedirectLoginOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - VerifyParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ApiRouteDefinition -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthenticatorType -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Cacheable -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ConnectAccountRedirectResult -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - ConnectedAccount -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - CustomFetchMinimalOutput -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - CustomTokenExchangeOptions -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollmentResponse -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - EnrollParams -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - FetcherConfig -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - InteractiveErrorHandler -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaFactorType -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - MfaGrantType -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - OobChannel -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - TokenEndpointResponse -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  Variables

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Auth0ClientService -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - AuthConfigService -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  Functions

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - authGuardFn -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - authHttpInterceptorFn -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - isHttpInterceptorRouteConfig -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - provideAuth0 -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Enumerations - - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Classes - - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Interfaces - - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Type Aliases - - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Variables - - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - Functions - - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  - - +@auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular

                                                                                                                                                                                                                                                                                                                                                                      Enumerations

                                                                                                                                                                                                                                                                                                                                                                      HttpMethod
                                                                                                                                                                                                                                                                                                                                                                      ResponseType

                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                      AbstractNavigator
                                                                                                                                                                                                                                                                                                                                                                      Auth0ClientFactory
                                                                                                                                                                                                                                                                                                                                                                      AuthClientConfig
                                                                                                                                                                                                                                                                                                                                                                      AuthenticationError
                                                                                                                                                                                                                                                                                                                                                                      AuthGuard
                                                                                                                                                                                                                                                                                                                                                                      AuthHttpInterceptor
                                                                                                                                                                                                                                                                                                                                                                      AuthModule
                                                                                                                                                                                                                                                                                                                                                                      AuthService
                                                                                                                                                                                                                                                                                                                                                                      AuthState
                                                                                                                                                                                                                                                                                                                                                                      ConnectError
                                                                                                                                                                                                                                                                                                                                                                      Fetcher
                                                                                                                                                                                                                                                                                                                                                                      GenericError
                                                                                                                                                                                                                                                                                                                                                                      InMemoryCache
                                                                                                                                                                                                                                                                                                                                                                      LocalStorageCache
                                                                                                                                                                                                                                                                                                                                                                      MfaChallengeError
                                                                                                                                                                                                                                                                                                                                                                      MfaEnrollmentError
                                                                                                                                                                                                                                                                                                                                                                      MfaEnrollmentFactorsError
                                                                                                                                                                                                                                                                                                                                                                      MfaError
                                                                                                                                                                                                                                                                                                                                                                      MfaListAuthenticatorsError
                                                                                                                                                                                                                                                                                                                                                                      MfaRequiredError
                                                                                                                                                                                                                                                                                                                                                                      MfaVerifyError
                                                                                                                                                                                                                                                                                                                                                                      MissingRefreshTokenError
                                                                                                                                                                                                                                                                                                                                                                      MyAccountApiError
                                                                                                                                                                                                                                                                                                                                                                      PasskeyChallengeError
                                                                                                                                                                                                                                                                                                                                                                      PasskeyError
                                                                                                                                                                                                                                                                                                                                                                      PasskeyGetTokenError
                                                                                                                                                                                                                                                                                                                                                                      PasskeyRegisterError
                                                                                                                                                                                                                                                                                                                                                                      PopupCancelledError
                                                                                                                                                                                                                                                                                                                                                                      PopupOpenError
                                                                                                                                                                                                                                                                                                                                                                      PopupTimeoutError
                                                                                                                                                                                                                                                                                                                                                                      TimeoutError
                                                                                                                                                                                                                                                                                                                                                                      UseDpopNonceError
                                                                                                                                                                                                                                                                                                                                                                      User

                                                                                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                                                                                      AppState
                                                                                                                                                                                                                                                                                                                                                                      AuthConfig
                                                                                                                                                                                                                                                                                                                                                                      Authenticator
                                                                                                                                                                                                                                                                                                                                                                      AuthorizationParams
                                                                                                                                                                                                                                                                                                                                                                      ChallengeAuthenticatorParams
                                                                                                                                                                                                                                                                                                                                                                      ChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      EmailAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      EmailEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      EmailEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                                                      EnrollmentFactor
                                                                                                                                                                                                                                                                                                                                                                      EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                                                      EnrollPushParams
                                                                                                                                                                                                                                                                                                                                                                      EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                                                      EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                                                      Factor
                                                                                                                                                                                                                                                                                                                                                                      GetTokenSilentlyOptions
                                                                                                                                                                                                                                                                                                                                                                      GetTokenWithPopupOptions
                                                                                                                                                                                                                                                                                                                                                                      HttpInterceptorConfig
                                                                                                                                                                                                                                                                                                                                                                      HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                      ICache
                                                                                                                                                                                                                                                                                                                                                                      IdToken
                                                                                                                                                                                                                                                                                                                                                                      LogoutOptions
                                                                                                                                                                                                                                                                                                                                                                      MyAccountApiClient
                                                                                                                                                                                                                                                                                                                                                                      ObservableMfaApiClient
                                                                                                                                                                                                                                                                                                                                                                      ObservableMyAccountApiClient
                                                                                                                                                                                                                                                                                                                                                                      ObservablePasskeyApiClient
                                                                                                                                                                                                                                                                                                                                                                      OobEnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                      OtpEnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                      PasskeyApiClient
                                                                                                                                                                                                                                                                                                                                                                      PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      PasskeyCreationOptions
                                                                                                                                                                                                                                                                                                                                                                      PasskeyCredentialResponse
                                                                                                                                                                                                                                                                                                                                                                      PasskeyEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      PasskeyErrorResponse
                                                                                                                                                                                                                                                                                                                                                                      PasskeyLoginChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      PasskeyLoginChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      PasskeyRequestOptions
                                                                                                                                                                                                                                                                                                                                                                      PasskeySignupChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      PasswordEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      PasswordEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      PasswordEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      PhoneEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      PopupConfigOptions
                                                                                                                                                                                                                                                                                                                                                                      PopupLoginOptions
                                                                                                                                                                                                                                                                                                                                                                      PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      PushNotificationEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      RedirectConnectAccountOptions
                                                                                                                                                                                                                                                                                                                                                                      RedirectLoginOptions
                                                                                                                                                                                                                                                                                                                                                                      TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      TotpEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      UpdateAuthenticationMethodRequest
                                                                                                                                                                                                                                                                                                                                                                      VerifyParams
                                                                                                                                                                                                                                                                                                                                                                      WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      WebAuthnRoamingAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                                                                                                      ApiRouteDefinition
                                                                                                                                                                                                                                                                                                                                                                      AuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      AuthenticationMethodType
                                                                                                                                                                                                                                                                                                                                                                      AuthenticatorType
                                                                                                                                                                                                                                                                                                                                                                      Cacheable
                                                                                                                                                                                                                                                                                                                                                                      ConnectAccountRedirectResult
                                                                                                                                                                                                                                                                                                                                                                      ConnectedAccount
                                                                                                                                                                                                                                                                                                                                                                      CustomFetchMinimalOutput
                                                                                                                                                                                                                                                                                                                                                                      CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                                                                                                      EnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      EnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                      EnrollmentResponse
                                                                                                                                                                                                                                                                                                                                                                      EnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                      EnrollParams
                                                                                                                                                                                                                                                                                                                                                                      FetcherConfig
                                                                                                                                                                                                                                                                                                                                                                      InteractiveErrorHandler
                                                                                                                                                                                                                                                                                                                                                                      MfaFactorType
                                                                                                                                                                                                                                                                                                                                                                      MfaGrantType
                                                                                                                                                                                                                                                                                                                                                                      OobChannel
                                                                                                                                                                                                                                                                                                                                                                      PasskeyLoginOptions
                                                                                                                                                                                                                                                                                                                                                                      PasskeySignupChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                      PasskeySignupOptions
                                                                                                                                                                                                                                                                                                                                                                      TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                                                                                                                                                      Auth0ClientService
                                                                                                                                                                                                                                                                                                                                                                      AuthConfigService

                                                                                                                                                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                                                                                                                                                      authGuardFn
                                                                                                                                                                                                                                                                                                                                                                      authHttpInterceptorFn
                                                                                                                                                                                                                                                                                                                                                                      isHttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                      provideAuth0

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Enumerations
                                                                                                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                                                                                                                                                                                      AppStateAuthConfigAuthenticatorAuthorizationParamsChallengeAuthenticatorParamsChallengeResponseEmailAuthenticationMethodEmailEnrollmentChallengeOptionsEmailEnrollmentChallengeResponseEmailEnrollmentVerifyOptionsEnrollEmailParamsEnrollmentFactorEnrollOtpParamsEnrollPushParamsEnrollSmsParamsEnrollVoiceParamsFactorGetTokenSilentlyOptionsGetTokenWithPopupOptionsHttpInterceptorConfigHttpInterceptorRouteConfigICacheIdTokenLogoutOptionsMyAccountApiClientObservableMfaApiClientObservableMyAccountApiClientObservablePasskeyApiClientOobEnrollmentResponseOtpEnrollmentResponsePasskeyApiClientPasskeyAuthenticationMethodPasskeyCreationOptionsPasskeyCredentialResponsePasskeyEnrollmentChallengeOptionsPasskeyEnrollmentChallengeResponsePasskeyEnrollmentVerifyOptionsPasskeyErrorResponsePasskeyLoginChallengeOptionsPasskeyLoginChallengeResponsePasskeyRequestOptionsPasskeySignupChallengeResponsePasswordAuthenticationMethodPasswordEnrollmentChallengeOptionsPasswordEnrollmentChallengeResponsePasswordEnrollmentVerifyOptionsPhoneAuthenticationMethodPhoneEnrollmentChallengeOptionsPhoneEnrollmentChallengeResponsePhoneEnrollmentVerifyOptionsPopupConfigOptionsPopupLoginOptionsPushNotificationAuthenticationMethodPushNotificationEnrollmentChallengeOptionsPushNotificationEnrollmentChallengeResponsePushNotificationEnrollmentVerifyOptionsRecoveryCodeAuthenticationMethodRecoveryCodeEnrollmentChallengeOptionsRecoveryCodeEnrollmentChallengeResponseRecoveryCodeEnrollmentVerifyOptionsRedirectConnectAccountOptionsRedirectLoginOptionsTotpAuthenticationMethodTotpEnrollmentChallengeOptionsTotpEnrollmentChallengeResponseTotpEnrollmentVerifyOptionsUpdateAuthenticationMethodRequestVerifyParamsWebAuthnPlatformAuthenticationMethodWebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                                                                                                      Variables
                                                                                                                                                                                                                                                                                                                                                                      Functions
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/ApiRouteDefinition.html b/docs/types/ApiRouteDefinition.html index f366dc42..075ec1d2 100644 --- a/docs/types/ApiRouteDefinition.html +++ b/docs/types/ApiRouteDefinition.html @@ -1,266 +1,6 @@ - - - - - - ApiRouteDefinition | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                        Type Alias ApiRouteDefinition

                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - ApiRouteDefinition: - HttpInterceptorRouteConfig - | - string -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                        Defines the type for a route config entry. Can either be:

                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                        • an object of type HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                        • a string
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        - - +ApiRouteDefinition | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Type Alias ApiRouteDefinition

                                                                                                                                                                                                                                                                                                                                                                          ApiRouteDefinition: HttpInterceptorRouteConfig | string

                                                                                                                                                                                                                                                                                                                                                                          Defines the type for a route config entry. Can either be:

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                          • an object of type HttpInterceptorRouteConfig
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                          • a string
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/AuthenticationMethod.html b/docs/types/AuthenticationMethod.html new file mode 100644 index 00000000..209470fe --- /dev/null +++ b/docs/types/AuthenticationMethod.html @@ -0,0 +1 @@ +AuthenticationMethod | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Type Alias AuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                            AuthenticationMethod:
                                                                                                                                                                                                                                                                                                                                                                                | PasskeyAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | WebAuthnPlatformAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | WebAuthnRoamingAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | PhoneAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | EmailAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | PasswordAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | TotpAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | PushNotificationAuthenticationMethod
                                                                                                                                                                                                                                                                                                                                                                                | RecoveryCodeAuthenticationMethod

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/AuthenticationMethodType.html b/docs/types/AuthenticationMethodType.html new file mode 100644 index 00000000..0305b775 --- /dev/null +++ b/docs/types/AuthenticationMethodType.html @@ -0,0 +1 @@ +AuthenticationMethodType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Type Alias AuthenticationMethodType

                                                                                                                                                                                                                                                                                                                                                                              AuthenticationMethodType:
                                                                                                                                                                                                                                                                                                                                                                                  | "passkey"
                                                                                                                                                                                                                                                                                                                                                                                  | "password"
                                                                                                                                                                                                                                                                                                                                                                                  | "phone"
                                                                                                                                                                                                                                                                                                                                                                                  | "totp"
                                                                                                                                                                                                                                                                                                                                                                                  | "email"
                                                                                                                                                                                                                                                                                                                                                                                  | "push-notification"
                                                                                                                                                                                                                                                                                                                                                                                  | "recovery-code"
                                                                                                                                                                                                                                                                                                                                                                                  | "webauthn-platform"
                                                                                                                                                                                                                                                                                                                                                                                  | "webauthn-roaming"

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/AuthenticatorType.html b/docs/types/AuthenticatorType.html index 97b3d819..1c58752f 100644 --- a/docs/types/AuthenticatorType.html +++ b/docs/types/AuthenticatorType.html @@ -1,260 +1,3 @@ - - - - - - AuthenticatorType | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                Type Alias AuthenticatorType

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - AuthenticatorType: - "otp" - | - "oob" - | - "recovery-code" -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                - Supported authenticator types. Note: Email authenticators use 'oob' - type with oobChannel: 'email' -

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                - - +AuthenticatorType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Type Alias AuthenticatorType

                                                                                                                                                                                                                                                                                                                                                                                  AuthenticatorType: "otp" | "oob" | "recovery-code"

                                                                                                                                                                                                                                                                                                                                                                                  Supported authenticator types. +Note: Email authenticators use 'oob' type with oobChannel: 'email'

                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index ddae7858..c9f6cbdf 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -1,252 +1 @@ - - - - - - Cacheable | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Cacheable

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    - Cacheable: - WrappedCacheEntry - | - KeyManifestEntry -
                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    - - +Cacheable | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Cacheable

                                                                                                                                                                                                                                                                                                                                                                                      Cacheable: WrappedCacheEntry | KeyManifestEntry

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index d9fe4eea..543d67c5 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -1,351 +1,10 @@ - - - - - - ConnectAccountRedirectResult | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ConnectAccountRedirectResult<TAppState>

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        - ConnectAccountRedirectResult: - CompleteResponse - & - {
                                                                                                                                                                                                                                                                                                                                                                                            appState?: - TAppState;
                                                                                                                                                                                                                                                                                                                                                                                            response_type: - ConnectCode;
                                                                                                                                                                                                                                                                                                                                                                                        } -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        - The result returned after a successful account connection redirect. -

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        - Combines the redirect login result (including any persisted app - state) with the complete response from the My Account API. -

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                        • - TAppState = - any -
                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          - The type of application state persisted through the - transaction. -

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                          - OptionalappState?: TAppState -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          State stored when the redirect request was made

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                          - response_type: ConnectCode -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          - The type of response, for connect account it will be - connect_code -

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        - - 
                                                                                                                                                                                                                                                                                                                                                                                        const result = await auth0.connectAccountWithRedirect(options);
                                                                                                                                                                                                                                                                                                                                                                                        console.log(result.appState); // Access persisted app state
                                                                                                                                                                                                                                                                                                                                                                                        console.log(result.connection);   // The connection of the account you connected to.
                                                                                                                                                                                                                                                                                                                                                                                        console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
+ConnectAccountRedirectResult | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ConnectAccountRedirectResult<TAppState>
                                                                                                                                                                                                                                                                                                                                                                                          ConnectAccountRedirectResult: CompleteResponse & {
                                                                                                                                                                                                                                                                                                                                                                                              appState?: TAppState;
                                                                                                                                                                                                                                                                                                                                                                                              response_type: ConnectCode;
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          The result returned after a successful account connection redirect.
                                                                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                                                                          Combines the redirect login result (including any persisted app state)
+with the complete response from the My Account API.
                                                                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters
                                                                                                                                                                                                                                                                                                                                                                                          • TAppState = any
                                                                                                                                                                                                                                                                                                                                                                                            The type of application state persisted through the transaction.
                                                                                                                                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration
                                                                                                                                                                                                                                                                                                                                                                                          • OptionalappState?: TAppState
                                                                                                                                                                                                                                                                                                                                                                                            State stored when the redirect request was made
                                                                                                                                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                                                                                                                                          • response_type: ConnectCode
                                                                                                                                                                                                                                                                                                                                                                                            The type of response, for connect account it will be connect_code
                                                                                                                                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                                                                                                                                          const result = await auth0.connectAccountWithRedirect(options);
                                                                                                                                                                                                                                                                                                                                                                                          console.log(result.appState); // Access persisted app state
                                                                                                                                                                                                                                                                                                                                                                                          console.log(result.connection);   // The connection of the account you connected to.
                                                                                                                                                                                                                                                                                                                                                                                          console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
 
                                                                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                          
-        
-      
                                                                                                                                                                                                                                                                                                                                                                                          
-      
                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                                                                                                                                          
-              
-                
-                
                                                                                                                                                                                                                                                                                                                                                                                          Settings
                                                                                                                                                                                                                                                                                                                                                                                          
-                                                                                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                                                                          
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                                                                                                                            
-                    
                                                                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                                                                            • 
-                    
                                                                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                                                                            • 
-                    
                                                                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                                                                            • 
-                  
                                                                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                                                                          
-                  
-                
                                                                                                                                                                                                                                                                                                                                                                                          
-              
                                                                                                                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                          
-          
-        
                                                                                                                                                                                                                                                                                                                                                                                          
-      
                                                                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                                                                          
-  
-
+
+

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/ConnectedAccount.html b/docs/types/ConnectedAccount.html index 50411ebf..132eb5b8 100644 --- a/docs/types/ConnectedAccount.html +++ b/docs/types/ConnectedAccount.html @@ -1,269 +1,2 @@ - - - - - - ConnectedAccount | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                                                                                                                             - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - ConnectedAccount: - Omit<
                                                                                                                                                                                                                                                                                                                                                                                                ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                                                                                                "appState"
                                                                                                                                                                                                                                                                                                                                                                                                | - "response_type",
                                                                                                                                                                                                                                                                                                                                                                                            > -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                            • - -
                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            - - +ConnectedAccount | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ConnectedAccount

                                                                                                                                                                                                                                                                                                                                                                                              ConnectedAccount: Omit<
                                                                                                                                                                                                                                                                                                                                                                                                  ConnectAccountRedirectResult,
                                                                                                                                                                                                                                                                                                                                                                                                  "appState"
                                                                                                                                                                                                                                                                                                                                                                                                  | "response_type",
                                                                                                                                                                                                                                                                                                                                                                                              >

                                                                                                                                                                                                                                                                                                                                                                                              The account that has been connected during the connect flow.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/CustomFetchMinimalOutput.html b/docs/types/CustomFetchMinimalOutput.html index dac4bafd..71f8e2ff 100644 --- a/docs/types/CustomFetchMinimalOutput.html +++ b/docs/types/CustomFetchMinimalOutput.html @@ -1,426 +1,3 @@ - - - - - - CustomFetchMinimalOutput | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                                Type Alias CustomFetchMinimalOutput

                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - type - CustomFetchMinimalOutput - = - {
                                                                                                                                                                                                                                                                                                                                                                                                    headers: - ResponseHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                    status: - number;
                                                                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - - headers - - status -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                - headers: - ResponseHeaders -
                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                - status: - number -
                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                - - +CustomFetchMinimalOutput | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias CustomFetchMinimalOutput

                                                                                                                                                                                                                                                                                                                                                                                                  type CustomFetchMinimalOutput = {
                                                                                                                                                                                                                                                                                                                                                                                                      headers: ResponseHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                      status: number;
                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  headers +status +

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  headers: ResponseHeaders
                                                                                                                                                                                                                                                                                                                                                                                                  status: number

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/CustomTokenExchangeOptions.html b/docs/types/CustomTokenExchangeOptions.html index 262341ff..1b39bc56 100644 --- a/docs/types/CustomTokenExchangeOptions.html +++ b/docs/types/CustomTokenExchangeOptions.html @@ -1,813 +1,65 @@ - - - - - - CustomTokenExchangeOptions | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias CustomTokenExchangeOptions

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    - Represents the configuration options required for initiating a - Custom Token Exchange request following RFC 8693 specifications. -

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                    - RFC 8693: OAuth 2.0 Token Exchange -

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    - type - CustomTokenExchangeOptions - = - {
                                                                                                                                                                                                                                                                                                                                                                                                        audience?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        organization?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        scope?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        subject_token: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        subject_token_type: - string;
                                                                                                                                                                                                                                                                                                                                                                                                        [key: - string]: - unknown;
                                                                                                                                                                                                                                                                                                                                                                                                    } -
                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                      - [key: - string]: - unknown -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Additional custom parameters for Auth0 Action processing

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                                                                                      - Accessible in Action code via - event.request.body -

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - 
                                                                                                                                                                                                                                                                                                                                                                                                      {
                                                                                                                                                                                                                                                                                                                                                                                                        custom_parameter: "session_context",
                                                                                                                                                                                                                                                                                                                                                                                                        device_fingerprint: "a3d8f7...",
                                                                                                                                                                                                                                                                                                                                                                                                      }
+CustomTokenExchangeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias CustomTokenExchangeOptions
                                                                                                                                                                                                                                                                                                                                                                                                        Represents the configuration options required for initiating a Custom Token Exchange request
+following RFC 8693 specifications.
                                                                                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                                                                                        RFC 8693: OAuth 2.0 Token Exchange
                                                                                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                                                                                        type CustomTokenExchangeOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                            actor_token?: string;
                                                                                                                                                                                                                                                                                                                                                                                                            actor_token_type?: string;
                                                                                                                                                                                                                                                                                                                                                                                                            audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                                            organization?: string;
                                                                                                                                                                                                                                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                            subject_token: string;
                                                                                                                                                                                                                                                                                                                                                                                                            subject_token_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                            [key: string]: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                        Indexable
                                                                                                                                                                                                                                                                                                                                                                                                        • [key: string]: unknown
                                                                                                                                                                                                                                                                                                                                                                                                          Additional custom parameters for Auth0 Action processing
                                                                                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                                                                                          Accessible in Action code via event.request.body
                                                                                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                                                                                          {
                                                                                                                                                                                                                                                                                                                                                                                                            custom_parameter: "session_context",
                                                                                                                                                                                                                                                                                                                                                                                                            device_fingerprint: "a3d8f7...",
                                                                                                                                                                                                                                                                                                                                                                                                          }
 
                                                                                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                                                                                          
-              
                                                                                                                                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                                                                                                                                                          • 
-          
                                                                                                                                                                                                                                                                                                                                                                                                        
-        
                                                                                                                                                                                                                                                                                                                                                                                                        
-        
-        
                                                                                                                                                                                                                                                                                                                                                                                                        
-          
                                                                                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                                                                                        
-              
-                
-                
                                                                                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                                                                                        
-                                                                                                                                                                                                                                                                                                                                                                                                                      
-              
                                                                                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                                                                                        
-                  
                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                        
-                  
                                                                                                                                                                                                                                                                                                                                                                                                        
-                    
-                        audience?
-                    
-                        organization?
-                    
-                        scope?
-                    
-                        subject_token
-                    
-                        subject_token_type
-                  
                                                                                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                                                                                        
-          
                                                                                                                                                                                                                                                                                                                                                                                                        
-        
                                                                                                                                                                                                                                                                                                                                                                                                        
-        
                                                                                                                                                                                                                                                                                                                                                                                                        
-          
-            
-            
                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                        
-                                                                                                                                                                                                                                                                                                                                                                                                                  
-          
                                                                                                                                                                                                                                                                                                                                                                                                        
-            
                                                                                                                                                                                                                                                                                                                                                                                                        
-              
-              
                                                                                                                                                                                                                                                                                                                                                                                                        
-                audience?:
-                string
-              
                                                                                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                                                                                        The target audience for the requested Auth0 token
                                                                                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                                                                                        
-                  
-                  
                                                                                                                                                                                                                                                                                                                                                                                                        
-                    Must match exactly with an API identifier configured in your
-                    Auth0 tenant. If not provided, falls back to the client's
-                    default audience.
-                  
                                                                                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                                                                                        
-                
                                                                                                                                                                                                                                                                                                                                                                                                        
-                  
-                  
                                                                                                                                                                                                                                                                                                                                                                                                        "https://api.your-service.com/v1"
+
+
                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      actor_token? +actor_token_type? +audience? +organization? +scope? +subject_token +subject_token_type +

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      actor_token?: string

                                                                                                                                                                                                                                                                                                                                                                                                      A token representing the acting party for delegation or impersonation scenarios.

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Used when one principal needs to act on behalf of another. +For example, an AI agent acting on behalf of a user.

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      - organization?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      - ID or name of the organization to use when authenticating a - user. When provided, the user will be authenticated using the - organization context. The organization ID will be present in - the access token payload. -

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      - scope?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      Space-separated list of OAuth 2.0 scopes being requested

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                                                                                      - Subject to API authorization policies configured in Auth0 -

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - 
                                                                                                                                                                                                                                                                                                                                                                                                      "openid profile email read:data write:data"
+
+
                                                                                                                                                                                                                                                                                                                                                                                                      actor_token_type?: string

                                                                                                                                                                                                                                                                                                                                                                                                      The type identifier for the actor token.

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Must be a URI under your organization's control, following the same +rules as subject_token_type.

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      "https://idp.example.com/token-type/agent"
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      - subject_token: - string -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      The opaque token value being exchanged for Auth0 tokens

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                      • - Must be validated in Auth0 Actions using strong - cryptographic verification -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      • Implement replay attack protection
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      • - Recommended validation libraries: jose, - jsonwebtoken -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - 
                                                                                                                                                                                                                                                                                                                                                                                                      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+
+
                                                                                                                                                                                                                                                                                                                                                                                                      audience?: string

                                                                                                                                                                                                                                                                                                                                                                                                      The target audience for the requested Auth0 token

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Must match exactly with an API identifier configured in your Auth0 tenant. +If not provided, falls back to the client's default audience.

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      "https://api.your-service.com/v1"
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      - subject_token_type: - string -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                      The type identifier for the subject token being exchanged

                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                      • - Must be a namespaced URI under your organization's control -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      • - Forbidden patterns: -
                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                        • - ^urn:ietf:params:oauth:* (IETF reserved) -
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                        • - ^https://auth0\.com/* (Auth0 reserved) -
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                        • ^urn:auth0:* (Auth0 reserved)
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - 
                                                                                                                                                                                                                                                                                                                                                                                                      "urn:acme:legacy-system-token"
                                                                                                                                                                                                                                                                                                                                                                                                      "https://api.yourcompany.com/token-type/v1"
+
+
                                                                                                                                                                                                                                                                                                                                                                                                      organization?: string

                                                                                                                                                                                                                                                                                                                                                                                                      ID or name of the organization to use when authenticating a user. +When provided, the user will be authenticated using the organization context. +The organization ID will be present in the access token payload.

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      scope?: string

                                                                                                                                                                                                                                                                                                                                                                                                      Space-separated list of OAuth 2.0 scopes being requested

                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Subject to API authorization policies configured in Auth0

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      "openid profile email read:data write:data"
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - Properties - - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - - + +
                                                                                                                                                                                                                                                                                                                                                                                                      subject_token: string

                                                                                                                                                                                                                                                                                                                                                                                                      The opaque token value being exchanged for Auth0 tokens

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                      • Must be validated in Auth0 Actions using strong cryptographic verification
                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                      • Implement replay attack protection
                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                      • Recommended validation libraries: jose, jsonwebtoken
                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      subject_token_type: string

                                                                                                                                                                                                                                                                                                                                                                                                      The type identifier for the subject token being exchanged

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                      • Must be a namespaced URI under your organization's control
                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                      • Forbidden patterns: +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                        • ^urn:ietf:params:oauth:* (IETF reserved)
                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                        • ^https://auth0\.com/* (Auth0 reserved)
                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                        • ^urn:auth0:* (Auth0 reserved)
                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      "urn:acme:legacy-system-token"
                                                                                                                                                                                                                                                                                                                                                                                                      "https://api.yourcompany.com/token-type/v1"
+
                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/EnrollParams.html b/docs/types/EnrollParams.html index cf587d98..0b1d4ab5 100644 --- a/docs/types/EnrollParams.html +++ b/docs/types/EnrollParams.html @@ -1,280 +1,2 @@ - - - - - - EnrollParams | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EnrollParams

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - EnrollParams:
                                                                                                                                                                                                                                                                                                                                                                                                            | - EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                                                                                            | - EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                                                                                            | - EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                                                                                            | - EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                                                                                            | - EnrollPushParams -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Union type for all enrollment parameter types

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - - -

                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                        • - -
                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        - - +EnrollParams | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EnrollParams

                                                                                                                                                                                                                                                                                                                                                                                                          EnrollParams:
                                                                                                                                                                                                                                                                                                                                                                                                              | EnrollOtpParams
                                                                                                                                                                                                                                                                                                                                                                                                              | EnrollSmsParams
                                                                                                                                                                                                                                                                                                                                                                                                              | EnrollVoiceParams
                                                                                                                                                                                                                                                                                                                                                                                                              | EnrollEmailParams
                                                                                                                                                                                                                                                                                                                                                                                                              | EnrollPushParams

                                                                                                                                                                                                                                                                                                                                                                                                          Union type for all enrollment parameter types

                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/EnrollmentChallengeOptions.html b/docs/types/EnrollmentChallengeOptions.html new file mode 100644 index 00000000..de81596e --- /dev/null +++ b/docs/types/EnrollmentChallengeOptions.html @@ -0,0 +1 @@ +EnrollmentChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias EnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                            EnrollmentChallengeOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                | PasskeyEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                | PhoneEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                | EmailEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                | TotpEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                | PushNotificationEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                | RecoveryCodeEnrollmentChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                                | PasswordEnrollmentChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/EnrollmentChallengeResponse.html b/docs/types/EnrollmentChallengeResponse.html new file mode 100644 index 00000000..6414598d --- /dev/null +++ b/docs/types/EnrollmentChallengeResponse.html @@ -0,0 +1 @@ +EnrollmentChallengeResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias EnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                              EnrollmentChallengeResponse:
                                                                                                                                                                                                                                                                                                                                                                                                                  | PasskeyEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                  | PhoneEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                  | EmailEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                  | TotpEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                  | PushNotificationEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                  | RecoveryCodeEnrollmentChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                                  | PasswordEnrollmentChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/EnrollmentResponse.html b/docs/types/EnrollmentResponse.html index 1591a3ba..70f18589 100644 --- a/docs/types/EnrollmentResponse.html +++ b/docs/types/EnrollmentResponse.html @@ -1,263 +1,2 @@ - - - - - - EnrollmentResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - EnrollmentResponse: - OtpEnrollmentResponse - | - OobEnrollmentResponse -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Union type for all enrollment response types

                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                - - +EnrollmentResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias EnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                  EnrollmentResponse: OtpEnrollmentResponse | OobEnrollmentResponse

                                                                                                                                                                                                                                                                                                                                                                                                                  Union type for all enrollment response types

                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/EnrollmentVerifyOptions.html b/docs/types/EnrollmentVerifyOptions.html new file mode 100644 index 00000000..9cd9fe4b --- /dev/null +++ b/docs/types/EnrollmentVerifyOptions.html @@ -0,0 +1 @@ +EnrollmentVerifyOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias EnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                    EnrollmentVerifyOptions:
                                                                                                                                                                                                                                                                                                                                                                                                                        | PasskeyEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        | PhoneEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        | EmailEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        | TotpEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        | PushNotificationEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        | RecoveryCodeEnrollmentVerifyOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        | PasswordEnrollmentVerifyOptions

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/FetcherConfig.html b/docs/types/FetcherConfig.html index 265e11c0..e498f181 100644 --- a/docs/types/FetcherConfig.html +++ b/docs/types/FetcherConfig.html @@ -1,561 +1,5 @@ - - - - - - FetcherConfig | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                                       - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias FetcherConfig<TOutput>

                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - type - FetcherConfig<TOutput - extends - CustomFetchMinimalOutput> - = - {
                                                                                                                                                                                                                                                                                                                                                                                                                          baseUrl?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                          dpopNonceId?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                          fetch?: - CustomFetchImpl<TOutput>;
                                                                                                                                                                                                                                                                                                                                                                                                                          getAccessToken?: - AccessTokenFactory;
                                                                                                                                                                                                                                                                                                                                                                                                                      } -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - - -
                                                                                                                                                                                                                                                                                                                                                                                                                      Index
                                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - - baseUrl? - - dpopNonceId? - - fetch? - - getAccessToken? -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      - baseUrl?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      - dpopNonceId?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      - fetch?: - CustomFetchImpl<TOutput> -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      - getAccessToken?: - AccessTokenFactory -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - - Properties - - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                      - - +FetcherConfig | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias FetcherConfig<TOutput>

                                                                                                                                                                                                                                                                                                                                                                                                                        type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
                                                                                                                                                                                                                                                                                                                                                                                                                            baseUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            dpopNonceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                            fetch?: CustomFetchImpl<TOutput>;
                                                                                                                                                                                                                                                                                                                                                                                                                            getAccessToken?: AccessTokenFactory;
                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        baseUrl? +dpopNonceId? +fetch? +getAccessToken? +

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        baseUrl?: string
                                                                                                                                                                                                                                                                                                                                                                                                                        dpopNonceId?: string
                                                                                                                                                                                                                                                                                                                                                                                                                        fetch?: CustomFetchImpl<TOutput>
                                                                                                                                                                                                                                                                                                                                                                                                                        getAccessToken?: AccessTokenFactory

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/InteractiveErrorHandler.html b/docs/types/InteractiveErrorHandler.html index 9eb414f7..db97bba5 100644 --- a/docs/types/InteractiveErrorHandler.html +++ b/docs/types/InteractiveErrorHandler.html @@ -1,259 +1,5 @@ - - - - - - InteractiveErrorHandler | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                                                                                                                                           - -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias InteractiveErrorHandler

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - InteractiveErrorHandler: - "popup" -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          Configuration option for automatic interactive error handling.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                          • - 'popup': SDK automatically opens Universal Login - popup on MFA error -
                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - - -

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                          • - -
                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                          • - -
                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                          • - -
                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          - - +InteractiveErrorHandler | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias InteractiveErrorHandler

                                                                                                                                                                                                                                                                                                                                                                                                                            InteractiveErrorHandler: "popup"

                                                                                                                                                                                                                                                                                                                                                                                                                            Configuration option for automatic interactive error handling.

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                            • 'popup': SDK automatically opens Universal Login popup on MFA error
                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/MfaFactorType.html b/docs/types/MfaFactorType.html index 3dd80001..86a44657 100644 --- a/docs/types/MfaFactorType.html +++ b/docs/types/MfaFactorType.html @@ -1,261 +1,2 @@ - - - - - - MfaFactorType | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                            - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                                                                                                                                                                               - -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias MfaFactorType

                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - MfaFactorType: - "otp" - | - "sms" - | - "email" - | - "push" - | - "voice" -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Supported MFA factors for enrollment

                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - - -

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                              • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              - - +MfaFactorType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                              @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias MfaFactorType

                                                                                                                                                                                                                                                                                                                                                                                                                                MfaFactorType: "otp" | "sms" | "email" | "push" | "voice"

                                                                                                                                                                                                                                                                                                                                                                                                                                Supported MFA factors for enrollment

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/types/MfaGrantType.html b/docs/types/MfaGrantType.html index d95c21a1..e3b03d82 100644 --- a/docs/types/MfaGrantType.html +++ b/docs/types/MfaGrantType.html @@ -1,262 +1,2 @@ - - - - - - MfaGrantType | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                                                                                   - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias MfaGrantType

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - MfaGrantType: - typeof - MfaGrantTypes[keyof - typeof - MfaGrantTypes] -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  - Grant types for MFA verification (derived from MfaGrantTypes - constants) -

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  - - +MfaGrantType | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                  @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias MfaGrantType

                                                                                                                                                                                                                                                                                                                                                                                                                                    MfaGrantType: typeof MfaGrantTypes[keyof typeof MfaGrantTypes]

                                                                                                                                                                                                                                                                                                                                                                                                                                    Grant types for MFA verification (derived from MfaGrantTypes constants)

                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/types/OobChannel.html b/docs/types/OobChannel.html index 72374ba5..0f647c44 100644 --- a/docs/types/OobChannel.html +++ b/docs/types/OobChannel.html @@ -1,262 +1,3 @@ - - - - - - OobChannel | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                    - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                                                       - -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias OobChannel

                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - OobChannel: - "sms" - | - "voice" - | - "auth0" - | - "email" -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                      - Out-of-band delivery channels. Includes 'email' which is also - delivered out-of-band. -

                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                      - - +OobChannel | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                      @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias OobChannel

                                                                                                                                                                                                                                                                                                                                                                                                                                        OobChannel: "sms" | "voice" | "auth0" | "email"

                                                                                                                                                                                                                                                                                                                                                                                                                                        Out-of-band delivery channels. +Includes 'email' which is also delivered out-of-band.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/types/PasskeyLoginOptions.html b/docs/types/PasskeyLoginOptions.html new file mode 100644 index 00000000..658a52d3 --- /dev/null +++ b/docs/types/PasskeyLoginOptions.html @@ -0,0 +1,2 @@ +PasskeyLoginOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PasskeyLoginOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                          PasskeyLoginOptions: PasskeyLoginChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Options for passkey login (authenticating with an existing passkey).

                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/PasskeySignupChallengeOptions.html b/docs/types/PasskeySignupChallengeOptions.html new file mode 100644 index 00000000..308c8c5c --- /dev/null +++ b/docs/types/PasskeySignupChallengeOptions.html @@ -0,0 +1,4 @@ +PasskeySignupChallengeOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                          @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PasskeySignupChallengeOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                            PasskeySignupChallengeOptions: PasskeySignupChallengeBaseOptions & (
                                                                                                                                                                                                                                                                                                                                                                                                                                                | { email: string; phoneNumber?: string; username?: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                | { email?: string; phoneNumber: string; username?: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                | { email?: string; phoneNumber?: string; username: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                            )

                                                                                                                                                                                                                                                                                                                                                                                                                                            Options for requesting a passkey signup challenge.

                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            At least one user identifier (email, username, or phoneNumber) must be provided. +Which identifiers are accepted depends on what is configured on your database connection.

                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/types/PasskeySignupOptions.html b/docs/types/PasskeySignupOptions.html new file mode 100644 index 00000000..8c7aaf60 --- /dev/null +++ b/docs/types/PasskeySignupOptions.html @@ -0,0 +1,2 @@ +PasskeySignupOptions | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                            @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PasskeySignupOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                              PasskeySignupOptions: PasskeySignupChallengeOptions & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                              Options for passkey signup (registering a new user with a passkey).

                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index e53aba54..b27f33cb 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -1,620 +1,7 @@ - - - - - - TokenEndpointResponse | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                              - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                                                                 - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - type - TokenEndpointResponse - = - {
                                                                                                                                                                                                                                                                                                                                                                                                                                                    access_token: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    expires_in: - number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    id_token: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    refresh_token?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    scope?: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    token_type: - string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                } -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - access_token - - expires_in - - id_token - - refresh_token? - - scope? - - token_type -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - access_token: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - expires_in: - number -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - id_token: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - refresh_token?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - scope?: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - token_type: - string -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - Properties - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                - - +TokenEndpointResponse | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias TokenEndpointResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                  type TokenEndpointResponse = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      access_token: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      expires_in: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      id_token: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      refresh_token?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      token_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                  access_token +expires_in +id_token +refresh_token? +scope? +token_type +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                  access_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  expires_in: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                  id_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  refresh_token?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                  token_type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/variables/Auth0ClientService.html b/docs/variables/Auth0ClientService.html index 66fd81b2..fb7314d0 100644 --- a/docs/variables/Auth0ClientService.html +++ b/docs/variables/Auth0ClientService.html @@ -1,257 +1 @@ - - - - - - Auth0ClientService | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                                                                                                                                     - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Variable Auth0ClientServiceConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - Auth0ClientService: - InjectionToken<Auth0Client> = ... -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - Member Visibility -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - +Auth0ClientService | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                    @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Variable Auth0ClientServiceConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Auth0ClientService: InjectionToken<Auth0Client> = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/variables/AuthConfigService.html b/docs/variables/AuthConfigService.html index f47a5cb0..7addd8e6 100644 --- a/docs/variables/AuthConfigService.html +++ b/docs/variables/AuthConfigService.html @@ -1,282 +1,6 @@ - - - - - - AuthConfigService | @auth0/auth0-angular - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      - @auth0/auth0-angular - - - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                                                                                                                                         - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Variable AuthConfigServiceConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        - AuthConfigService: - InjectionToken<AuthConfig> = ... -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Injection token for accessing configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                        - Use the Inject decorator to access the configuration - from a service or component: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                        - 
                                                                                                                                                                                                                                                                                                                                                                                                                                                        class MyService(@Inject(AuthConfigService) config: AuthConfig) {}
+AuthConfigService | @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                        @auth0/auth0-angular
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Variable AuthConfigServiceConst
                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthConfigService: InjectionToken<AuthConfig> = ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Injection token for accessing configuration.
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Use the Inject decorator to access the configuration from a service or component:
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
+
                                                                                                                                                                                                                                                                                                                                                                                                                                                          class MyService(@Inject(AuthConfigService) config: AuthConfig) {}
 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-        
-      
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-      
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-              
-                
-                
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
-              
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-                  Member Visibility
-                  
                                                                                                                                                                                                                                                                                                                                                                                                                                                            
-                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 
-                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 
-                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 
-                      
-                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 
-                  
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-                
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-                  
-                
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-              
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-            
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-          
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-        
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-          
-        
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-      
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-    
                                                                                                                                                                                                                                                                                                                                                                                                                                                          
-  
-
+
+

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/projects/auth0-angular/package.json b/projects/auth0-angular/package.json index 5efd3f61..146a5a07 100644 --- a/projects/auth0-angular/package.json +++ b/projects/auth0-angular/package.json @@ -1,6 +1,6 @@ { "name": "@auth0/auth0-angular", - "version": "2.9.0", + "version": "2.10.0", "description": "Auth0 SDK for Angular Single Page Applications (SPA)", "keywords": [ "auth0",